fix: default to xcmPallet (#442)

README.md

@@ -266,6 +266,11 @@ interface TransferArgsOpts<T extends Format> {
 	 * Optional assetId that will be used to pay for fees. Used with the `dryRunCall` option to determine fees in the specified asset.
 	 */
 	xcmFeeAsset?: string;
+
+	/**
+	 * Optionally sets the pallet to be used for the current tx.
+	 */
+	xcmPalletOverride?: XcmPallet;
 }
 ```
 

src/AssetTransferApi.spec.ts

@@ -583,6 +583,7 @@ describe('AssetTransferAPI', () => {
 					{
 						format: 'call',
 						keepAlive: false,
+						xcmPalletOverride: 'xTokens',
 					},
 				);
 
@@ -604,6 +605,7 @@ describe('AssetTransferAPI', () => {
 						format: 'payload',
 						keepAlive: false,
 						sendersAddr: 'FBeL7DanUDs5SZrxZY1CizMaPgG9vZgJgvr52C2dg81SsF1',
+						xcmPalletOverride: 'xTokens',
 					},
 				);
 
@@ -622,6 +624,7 @@ describe('AssetTransferAPI', () => {
 					['10000000000000'],
 					{
 						format: 'submittable',
+						xcmPalletOverride: 'xTokens',
 					},
 				);
 

src/AssetTransferApi.ts

@@ -202,6 +202,7 @@ export class AssetTransferApi {
 			customXcmOnDest,
 			dryRunCall,
 			xcmFeeAsset,
+			xcmPalletOverride,
 		} = opts;
 
 		if (!this.registryConfig.registryInitialized) {
@@ -242,7 +243,7 @@ export class AssetTransferApi {
 		const xcmDirection = this.establishDirection(isLocalTx, chainOriginDestInfo);
 		const isForeignAssetsTransfer = await this.checkContainsForeignAssets(api, assetIds);
 		const isPrimaryParachainNativeAsset = isParachainPrimaryNativeAsset(registry, specName, xcmDirection, assetIds[0]);
-		const xcmPallet = establishXcmPallet(api, xcmDirection);
+		const xcmPallet = establishXcmPallet(api, xcmDirection, xcmPalletOverride);
 		const declaredXcmVersion = xcmVersion === undefined ? safeXcmVersion : xcmVersion;
 		checkXcmVersion(declaredXcmVersion); // Throws an error when the xcmVersion is not supported.
 

src/config/disabledOpts.ts

@@ -100,4 +100,9 @@ export const disabledOpts: DisabledOptions = {
 		chains: [],
 		error: (opt: string, chain: string) => callError(opt, chain),
 	},
+	xcmPalletOverride: {
+		disabled: false,
+		chains: [],
+		error: (opt: string, chain: string) => callError(opt, chain),
+	},
 };

src/createXcmCalls/util/establishXcmPallet.spec.ts

@@ -13,4 +13,9 @@ describe('establishXcmPallet', () => {
 		const res = establishXcmPallet(mockSystemApi);
 		expect(res).toEqual('polkadotXcm');
 	});
+	it('Should correctly throw an error when an overrided pallet is not found for the given runtime', () => {
+		const xcmPalletOverride = 'xTokens';
+		const err = () => establishXcmPallet(mockSystemApi, undefined, xcmPalletOverride);
+		expect(err).toThrow('Pallet xTokens not found in the current runtime.');
+	});
 });

src/createXcmCalls/util/establishXcmPallet.ts

@@ -4,7 +4,7 @@ import type { ApiPromise } from '@polkadot/api';
 
 import { SUPPORTED_XCM_PALLETS } from '../../consts';
 import { BaseError, BaseErrorsEnum } from '../../errors';
-import { Direction } from '../../types';
+import { Direction, XcmPallet } from '../../types';
 
 export enum XcmPalletName {
 	xcmPallet = 'xcmPallet',
@@ -20,7 +20,28 @@ export enum XcmPalletName {
  *
  * @param api ApiPromise
  */
-export const establishXcmPallet = (api: ApiPromise, direction?: Direction): XcmPalletName => {
+export const establishXcmPallet = (
+	api: ApiPromise,
+	direction?: Direction,
+	xcmPalletOverride?: XcmPallet,
+): XcmPalletName => {
+	if (xcmPalletOverride) {
+		if (api.tx[xcmPalletOverride]) {
+			return XcmPalletName[xcmPalletOverride];
+		} else {
+			throw new BaseError(
+				`Pallet ${xcmPalletOverride} not found in the current runtime.`,
+				BaseErrorsEnum.PalletNotFound,
+			);
+		}
+	}
+
+	if (api.tx.polkadotXcm) {
+		return XcmPalletName.polkadotXcm;
+	} else if (api.tx.xcmPallet) {
+		return XcmPalletName.xcmPallet;
+	}
+
 	let xPallet: XcmPalletName | undefined;
 
 	if (api.tx.xTokens) {
@@ -33,12 +54,6 @@ export const establishXcmPallet = (api: ApiPromise, direction?: Direction): XcmP
 		return xPallet as XcmPalletName;
 	}
 
-	if (api.tx.polkadotXcm) {
-		return XcmPalletName.polkadotXcm;
-	} else if (api.tx.xcmPallet) {
-		return XcmPalletName.xcmPallet;
-	}
-
 	const supportedPallets = SUPPORTED_XCM_PALLETS.map((pallet) => {
 		return pallet;
 	}).join(', ');