@paraspell/sdk-core 11.2.0 → 11.2.2

package/dist/index.d.ts

@@ -262,257 +262,6 @@ type TAssetClaimInternalOptions<TApi, TRes> = TAssetClaimOptions<TApi, TRes> & {
     assets: TAsset<bigint>[];
 };
 
-/**
- * Builder class for constructing asset claim transactions.
- */
-declare class AssetClaimBuilder<TApi, TRes, T extends Partial<TAssetClaimOptionsBase> = object> {
-    readonly api: IPolkadotApi<TApi, TRes>;
-    readonly _options: T;
-    constructor(api: IPolkadotApi<TApi, TRes>, options?: T);
-    /**
-     * Specifies the assets to be claimed.
-     *
-     * @param assets - An array of assets to claim in a multi-asset format.
-     * @returns An instance of Builder
-     */
-    currency(currency: TAssetClaimOptionsBase['currency']): AssetClaimBuilder<TApi, TRes, T & {
-        currency: TAssetClaimOptionsBase['currency'];
-    }>;
-    /**
-     * Specifies the account address on which the assets will be claimed.
-     *
-     * @param address - The destination account address.
-     * @returns An instance of Builder
-     */
-    address(address: TAddress): AssetClaimBuilder<TApi, TRes, T & {
-        address: TAddress;
-    }>;
-    /**
-     * Sets the XCM version to be used for the asset claim.
-     *
-     * @param version - The XCM version.
-     * @returns An instance of Builder
-     */
-    xcmVersion(version: Version): AssetClaimBuilder<TApi, TRes, T & {
-        version: Version;
-    }>;
-    /**
-     * Builds and returns the asset claim extrinsic.
-     *
-     * @returns A Promise that resolves to the asset claim extrinsic.
-     */
-    build(this: AssetClaimBuilder<TApi, TRes, TAssetClaimOptionsBase>): Promise<TRes>;
-    /**
-     * Returns the API instance used by the builder.
-     *
-     * @returns The API instance.
-     */
-    getApi(): TApi;
-    /**
-     * Disconnects the API.
-     *
-     * @returns A Promise that resolves when the API is disconnected.
-     */
-    disconnect(): Promise<void>;
-}
-
-declare class BatchTransactionManager<TApi, TRes> {
-    transactionOptions: TSendOptions<TApi, TRes>[];
-    addTransaction(options: TSendOptions<TApi, TRes>): void;
-    isEmpty(): boolean;
-    buildBatch(api: IPolkadotApi<TApi, TRes>, from: TSubstrateChain, options?: TBatchOptions): Promise<TRes>;
-}
-
-/**
- * A builder class for constructing Para-to-Para, Para-to-Relay, Relay-to-Para transactions and asset claims.
- */
-declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = object> {
-    readonly batchManager: BatchTransactionManager<TApi, TRes>;
-    readonly api: IPolkadotApi<TApi, TRes>;
-    readonly _options: T;
-    constructor(api: IPolkadotApi<TApi, TRes>, batchManager: BatchTransactionManager<TApi, TRes>, options?: T);
-    /**
-     * Specifies the origin chain for the transaction.
-     *
-     * @param chain - The chain from which the transaction originates.
-     * @returns An instance of Builder
-     */
-    from(chain: TSubstrateChain): GeneralBuilder<TApi, TRes, T & {
-        from: TSubstrateChain;
-    }>;
-    /**
-     * Specifies the destination chain for the transaction.
-     *
-     * @param chain - The chain to which the transaction is sent.
-     * @param paraIdTo - (Optional) The parachain ID of the destination chain.
-     * @returns An instance of Builder
-     */
-    to(chain: TDestination, paraIdTo?: number): GeneralBuilder<TApi, TRes, T & {
-        to: TDestination;
-    }>;
-    /**
-     * Initiates the process to claim assets from a specified chain.
-     *
-     * @param chain - The chain from which to claim assets.
-     * @returns An instance of Builder
-     */
-    claimFrom(chain: TSubstrateChain): AssetClaimBuilder<TApi, TRes, {
-        chain: TSubstrateChain;
-    }>;
-    /**
-     * Specifies the currency to be used in the transaction. Symbol, ID, location or multi-asset.
-     *
-     * @param currency - The currency to be transferred.
-     * @returns An instance of Builder
-     */
-    currency(currency: TCurrencyInputWithAmount): GeneralBuilder<TApi, TRes, T & {
-        currency: TCurrencyInputWithAmount;
-    }>;
-    /**
-     * Sets the recipient address.
-     *
-     * @param address - The destination address.
-     * @returns An instance of Builder
-     */
-    address(address: TAddress): 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.
-     *
-     * @param version - The XCM version.
-     * @returns An instance of Builder
-     */
-    xcmVersion(version: Version): GeneralBuilder<TApi, TRes, T & {
-        version: Version;
-    }>;
-    /**
-     * Sets a custom pallet for the transaction.
-     *
-     * @param palletName - The name of the custom pallet to be used.
-     * @returns An instance of the Builder.
-     */
-    customPallet(pallet: string, method: string): GeneralBuilder<TApi, TRes, T & {
-        pallet: string;
-        method: string;
-    }>;
-    /**
-     * Optional fee asset for the transaction.
-     *
-     * @param currency - The currency to be used for the fee.
-     * @returns An instance of the Builder
-     */
-    feeAsset(currency: TCurrencyInput | undefined): GeneralBuilder<TApi, TRes, T & {
-        feeAsset: TCurrencyInput | undefined;
-    }>;
-    /**
-     * Adds the transfer transaction to the batch.
-     *
-     * @returns An instance of Builder
-     */
-    addToBatch(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): GeneralBuilder<TApi, TRes, T & {
-        from: TSubstrateChain;
-    }>;
-    /**
-     * Builds and returns the batched transaction based on the configured parameters.
-     *
-     * @param options - (Optional) Options to customize the batch transaction.
-     * @returns A Extrinsic representing the batched transactions.
-     */
-    buildBatch(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>, options?: TBatchOptions): Promise<TRes>;
-    /**
-     * Builds and returns the transfer extrinsic.
-     *
-     * @returns A Promise that resolves to the transfer extrinsic.
-     */
-    build(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): Promise<TRes>;
-    dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TDryRunResult>;
-    /**
-     * Returns the XCM fee for the transfer using dryRun or paymentInfo function.
-     *
-     * @returns An origin and destination fee.
-     */
-    getXcmFee<TDisableFallback extends boolean = false>(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, options?: TGetXcmFeeBuilderOptions & {
-        disableFallback: TDisableFallback;
-    }): Promise<TGetXcmFeeResult<TDisableFallback>>;
-    /**
-     * Returns the origin XCM fee for the transfer using dryRun or paymentInfo function.
-     *
-     * @returns An origin fee.
-     */
-    getOriginXcmFee(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, { disableFallback }?: TGetXcmFeeBuilderOptions): Promise<TXcmFeeDetail & {
-        forwardedXcms?: any;
-        destParaId?: number;
-    }>;
-    /**
-     * Estimates the origin and destination XCM fee using paymentInfo function.
-     *
-     * @returns An origin and destination fee estimate.
-     */
-    getXcmFeeEstimate(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TGetXcmFeeEstimateResult>;
-    /**
-     * Estimates the origin XCM fee using paymentInfo function.
-     *
-     * @returns An origin fee estimate.
-     */
-    getOriginXcmFeeEstimate(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TGetXcmFeeEstimateDetail>;
-    /**
-     * Returns the max transferable amount for the transfer
-     *
-     * @returns The max transferable amount.
-     */
-    getTransferableAmount(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<bigint>;
-    /**
-     * Returns the max transferable amount for the transfer
-     *
-     * @returns The max transferable amount.
-     */
-    verifyEdOnDestination(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<boolean>;
-    /**
-     * Returns the transfer info for the transfer
-     *
-     * @returns The transfer info.
-     */
-    getTransferInfo(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TTransferInfo>;
-    /**
-     * Returns the API instance used by the builder.
-     *
-     * @returns The API instance.
-     */
-    getApi(): TApi;
-    /**
-     * Disconnects the API.
-     *
-     * @returns A Promise that resolves when the API is disconnected.
-     */
-    disconnect(): Promise<void>;
-}
-/**
- * Creates a new Builder instance.
- *
- * @param api - The API instance to use for building transactions. If not provided, a new instance will be created.
- * @returns A new Builder instance.
- */
-declare const Builder: <TApi, TRes>(api: IPolkadotApi<TApi, TRes>) => GeneralBuilder<TApi, TRes, object>;
-
 type TBalanceResponse = {
     free?: string;
     balance?: string;
@@ -633,7 +382,7 @@ type TGetMaxForeignTransferableAmountOptionsBase = {
     currency: TCurrencyCore;
 };
 type TGetMaxForeignTransferableAmountOptions<TApi, TRes> = WithApi<TGetMaxForeignTransferableAmountOptionsBase, TApi, TRes>;
-type TGetTransferableAmountOptionsBase<TApi, TRes> = {
+type TGetTransferableAmountOptionsBase<TRes> = {
     /**
      * The sender address of the account.
      */
@@ -651,12 +400,12 @@ type TGetTransferableAmountOptionsBase<TApi, TRes> = {
      */
     currency: WithAmount<TCurrencyCore>;
     /**
-     * The transaction builder
+     * The transaction instance
      */
-    builder: GeneralBuilder<TApi, TRes, TSendBaseOptions>;
+    tx: TRes;
     feeAsset?: TCurrencyInput;
 };
-type TGetTransferableAmountOptions<TApi, TRes> = WithApi<TGetTransferableAmountOptionsBase<TApi, TRes>, TApi, TRes>;
+type TGetTransferableAmountOptions<TApi, TRes> = WithApi<TGetTransferableAmountOptionsBase<TRes>, TApi, TRes>;
 type TVerifyEdOnDestinationOptionsBase<TRes> = {
     /**
      * The origin chain.
@@ -829,6 +578,7 @@ type TDryRunBaseOptions<TRes> = {
         currencyTo: TCurrencyCore;
         exchangeChain: TParachain;
     };
+    useRootOrigin?: boolean;
 };
 type TDryRunOptions<TApi, TRes> = WithApi<TDryRunBaseOptions<TRes>, TApi, TRes>;
 type TDryRunCallBaseOptions<TRes> = {
@@ -1216,6 +966,257 @@ type TTypeAndThenFees = {
     destFee: bigint;
 };
 
+/**
+ * Builder class for constructing asset claim transactions.
+ */
+declare class AssetClaimBuilder<TApi, TRes, T extends Partial<TAssetClaimOptionsBase> = object> {
+    readonly api: IPolkadotApi<TApi, TRes>;
+    readonly _options: T;
+    constructor(api: IPolkadotApi<TApi, TRes>, options?: T);
+    /**
+     * Specifies the assets to be claimed.
+     *
+     * @param assets - An array of assets to claim in a multi-asset format.
+     * @returns An instance of Builder
+     */
+    currency(currency: TAssetClaimOptionsBase['currency']): AssetClaimBuilder<TApi, TRes, T & {
+        currency: TAssetClaimOptionsBase['currency'];
+    }>;
+    /**
+     * Specifies the account address on which the assets will be claimed.
+     *
+     * @param address - The destination account address.
+     * @returns An instance of Builder
+     */
+    address(address: TAddress): AssetClaimBuilder<TApi, TRes, T & {
+        address: TAddress;
+    }>;
+    /**
+     * Sets the XCM version to be used for the asset claim.
+     *
+     * @param version - The XCM version.
+     * @returns An instance of Builder
+     */
+    xcmVersion(version: Version): AssetClaimBuilder<TApi, TRes, T & {
+        version: Version;
+    }>;
+    /**
+     * Builds and returns the asset claim extrinsic.
+     *
+     * @returns A Promise that resolves to the asset claim extrinsic.
+     */
+    build(this: AssetClaimBuilder<TApi, TRes, TAssetClaimOptionsBase>): Promise<TRes>;
+    /**
+     * Returns the API instance used by the builder.
+     *
+     * @returns The API instance.
+     */
+    getApi(): TApi;
+    /**
+     * Disconnects the API.
+     *
+     * @returns A Promise that resolves when the API is disconnected.
+     */
+    disconnect(): Promise<void>;
+}
+
+declare class BatchTransactionManager<TApi, TRes> {
+    transactionOptions: TSendOptions<TApi, TRes>[];
+    addTransaction(options: TSendOptions<TApi, TRes>): void;
+    isEmpty(): boolean;
+    buildBatch(api: IPolkadotApi<TApi, TRes>, from: TSubstrateChain, options?: TBatchOptions): Promise<TRes>;
+}
+
+/**
+ * A builder class for constructing Para-to-Para, Para-to-Relay, Relay-to-Para transactions and asset claims.
+ */
+declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = object> {
+    readonly batchManager: BatchTransactionManager<TApi, TRes>;
+    readonly api: IPolkadotApi<TApi, TRes>;
+    readonly _options: T;
+    constructor(api: IPolkadotApi<TApi, TRes>, batchManager: BatchTransactionManager<TApi, TRes>, options?: T);
+    /**
+     * Specifies the origin chain for the transaction.
+     *
+     * @param chain - The chain from which the transaction originates.
+     * @returns An instance of Builder
+     */
+    from(chain: TSubstrateChain): GeneralBuilder<TApi, TRes, T & {
+        from: TSubstrateChain;
+    }>;
+    /**
+     * Specifies the destination chain for the transaction.
+     *
+     * @param chain - The chain to which the transaction is sent.
+     * @param paraIdTo - (Optional) The parachain ID of the destination chain.
+     * @returns An instance of Builder
+     */
+    to(chain: TDestination, paraIdTo?: number): GeneralBuilder<TApi, TRes, T & {
+        to: TDestination;
+    }>;
+    /**
+     * Initiates the process to claim assets from a specified chain.
+     *
+     * @param chain - The chain from which to claim assets.
+     * @returns An instance of Builder
+     */
+    claimFrom(chain: TSubstrateChain): AssetClaimBuilder<TApi, TRes, {
+        chain: TSubstrateChain;
+    }>;
+    /**
+     * Specifies the currency to be used in the transaction. Symbol, ID, location or multi-asset.
+     *
+     * @param currency - The currency to be transferred.
+     * @returns An instance of Builder
+     */
+    currency(currency: TCurrencyInputWithAmount): GeneralBuilder<TApi, TRes, T & {
+        currency: TCurrencyInputWithAmount;
+    }>;
+    /**
+     * Sets the recipient address.
+     *
+     * @param address - The destination address.
+     * @returns An instance of Builder
+     */
+    address(address: TAddress): 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.
+     *
+     * @param version - The XCM version.
+     * @returns An instance of Builder
+     */
+    xcmVersion(version: Version): GeneralBuilder<TApi, TRes, T & {
+        version: Version;
+    }>;
+    /**
+     * Sets a custom pallet for the transaction.
+     *
+     * @param palletName - The name of the custom pallet to be used.
+     * @returns An instance of the Builder.
+     */
+    customPallet(pallet: string, method: string): GeneralBuilder<TApi, TRes, T & {
+        pallet: string;
+        method: string;
+    }>;
+    /**
+     * Optional fee asset for the transaction.
+     *
+     * @param currency - The currency to be used for the fee.
+     * @returns An instance of the Builder
+     */
+    feeAsset(currency: TCurrencyInput | undefined): GeneralBuilder<TApi, TRes, T & {
+        feeAsset: TCurrencyInput | undefined;
+    }>;
+    /**
+     * Adds the transfer transaction to the batch.
+     *
+     * @returns An instance of Builder
+     */
+    addToBatch(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): GeneralBuilder<TApi, TRes, T & {
+        from: TSubstrateChain;
+    }>;
+    /**
+     * Builds and returns the batched transaction based on the configured parameters.
+     *
+     * @param options - (Optional) Options to customize the batch transaction.
+     * @returns A Extrinsic representing the batched transactions.
+     */
+    buildBatch(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>, options?: TBatchOptions): Promise<TRes>;
+    /**
+     * Builds and returns the transfer extrinsic.
+     *
+     * @returns A Promise that resolves to the transfer extrinsic.
+     */
+    build(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): Promise<TRes>;
+    dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TDryRunResult>;
+    /**
+     * Returns the XCM fee for the transfer using dryRun or paymentInfo function.
+     *
+     * @returns An origin and destination fee.
+     */
+    getXcmFee<TDisableFallback extends boolean = false>(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, options?: TGetXcmFeeBuilderOptions & {
+        disableFallback: TDisableFallback;
+    }): Promise<TGetXcmFeeResult<TDisableFallback>>;
+    /**
+     * Returns the origin XCM fee for the transfer using dryRun or paymentInfo function.
+     *
+     * @returns An origin fee.
+     */
+    getOriginXcmFee(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, { disableFallback }?: TGetXcmFeeBuilderOptions): Promise<TXcmFeeDetail & {
+        forwardedXcms?: any;
+        destParaId?: number;
+    }>;
+    /**
+     * Estimates the origin and destination XCM fee using paymentInfo function.
+     *
+     * @returns An origin and destination fee estimate.
+     */
+    getXcmFeeEstimate(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TGetXcmFeeEstimateResult>;
+    /**
+     * Estimates the origin XCM fee using paymentInfo function.
+     *
+     * @returns An origin fee estimate.
+     */
+    getOriginXcmFeeEstimate(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TGetXcmFeeEstimateDetail>;
+    /**
+     * Returns the max transferable amount for the transfer
+     *
+     * @returns The max transferable amount.
+     */
+    getTransferableAmount(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<bigint>;
+    /**
+     * Returns the max transferable amount for the transfer
+     *
+     * @returns The max transferable amount.
+     */
+    verifyEdOnDestination(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<boolean>;
+    /**
+     * Returns the transfer info for the transfer
+     *
+     * @returns The transfer info.
+     */
+    getTransferInfo(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TTransferInfo>;
+    /**
+     * Returns the API instance used by the builder.
+     *
+     * @returns The API instance.
+     */
+    getApi(): TApi;
+    /**
+     * Disconnects the API.
+     *
+     * @returns A Promise that resolves when the API is disconnected.
+     */
+    disconnect(): Promise<void>;
+}
+/**
+ * Creates a new Builder instance.
+ *
+ * @param api - The API instance to use for building transactions. If not provided, a new instance will be created.
+ * @returns A new Builder instance.
+ */
+declare const Builder: <TApi, TRes>(api: IPolkadotApi<TApi, TRes>) => GeneralBuilder<TApi, TRes, object>;
+
 type TGetXcmFeeBaseOptions<TRes, TDisableFallback extends boolean = boolean> = {
     /**
      * The transaction to calculate the fee for
@@ -2034,7 +2035,7 @@ declare const getBalanceNative: <TApi, TRes>(options: TGetBalanceNativeOptions<T
 declare const getOriginFeeDetailsInternal: <TApi, TRes>({ api, account, accountDestination, ahAddress, currency, origin, destination, feeMarginPercentage }: TGetOriginFeeDetailsOptions<TApi, TRes>) => Promise<TOriginFeeDetails>;
 declare const getOriginFeeDetails: <TApi, TRes>(options: TGetOriginFeeDetailsOptions<TApi, TRes>) => Promise<TOriginFeeDetails>;
 
-declare const getTransferableAmountInternal: <TApi, TRes>({ api, senderAddress, origin: chain, destination, currency, builder, feeAsset }: TGetTransferableAmountOptions<TApi, TRes>) => Promise<bigint>;
+declare const getTransferableAmountInternal: <TApi, TRes>({ api, senderAddress, origin: chain, destination, currency, tx, feeAsset }: TGetTransferableAmountOptions<TApi, TRes>) => Promise<bigint>;
 declare const getTransferableAmount: <TApi, TRes>(options: TGetTransferableAmountOptions<TApi, TRes>) => Promise<bigint>;
 
 declare const getTransferInfo: <TApi, TRes>({ api, tx, origin, destination, senderAddress, ahAddress, address, currency, feeAsset }: TGetTransferInfoOptions<TApi, TRes>) => Promise<TTransferInfo>;