Using assert instead of if/throw

moonbeam-foundation · Aug 8, 2024 · 128946b · 128946b
1 parent 335837a
commit 128946b
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 36 deletions.
diff --git a/packages/builder/fixtures/builderParamsMock.ts b/packages/builder/fixtures/builderParamsMock.ts
@@ -133,3 +133,18 @@ export const mrlBuildParamsMock: MrlExtrinsicConfigBuilderPrams = {
     },
   },
 };
+
+export const mrlBuildParamsMock2: MrlExtrinsicConfigBuilderPrams = {
+  ...buildParachainParamsMock,
+  moonApi: {} as any,
+  moonAsset: testAssetAmount,
+  moonChain: moonbaseAlphaMock,
+  moonGasLimit: 999_999n,
+  transact: {
+    call: '0x4d79207465787420737472696e67',
+    txWeight: {
+      refTime: 24_902_375_000n,
+      proofSize: 62_193n,
+    },
+  },
+};
diff --git a/packages/builder/package.json b/packages/builder/package.json
@@ -39,6 +39,7 @@
   "dependencies": {
     "@moonbeam-network/xcm-types": "2.3.1",
     "@moonbeam-network/xcm-utils": "2.1.4",
+    "assert": "^2.1.0",
     "big.js": "^6.2.1"
   },
   "peerDependencies": {

diff --git a/packages/builder/src/extrinsic/mrl/wormhole/ethereumXcm/ethereumXcm.test.ts b/packages/builder/src/extrinsic/mrl/wormhole/ethereumXcm/ethereumXcm.test.ts
@@ -3,7 +3,10 @@
 import { describe, expect, it } from 'vitest';
 
 import { ethereumXcm } from './ethereumXcm';
-import { mrlBuildParamsMock } from '../../../../../fixtures';
+import {
+  mrlBuildParamsMock,
+  mrlBuildParamsMock2,
+} from '../../../../../fixtures';
 
 describe('ethereumXcm', () => {
   describe('transact', () => {
@@ -18,5 +21,16 @@ describe('ethereumXcm', () => {
     it('should get correct arguments', () => {
       expect(extrinsic.getArgs({} as any)).toMatchSnapshot();
     });
+
+    it('should throw and error because destination has no wh name', () => {
+      expect(() =>
+        ethereumXcm()
+          .transact({ isAutomatic: true })
+          .build(mrlBuildParamsMock2)
+          .getArgs({} as any),
+      ).toThrow(
+        'Destination chain Interlay Testnet does not have a wormhole name',
+      );
+    });
   });
 });
diff --git a/packages/builder/src/extrinsic/mrl/wormhole/ethereumXcm/ethereumXcm.ts b/packages/builder/src/extrinsic/mrl/wormhole/ethereumXcm/ethereumXcm.ts
@@ -2,6 +2,7 @@ import { convertAddressTo32Bytes } from '@moonbeam-network/xcm-utils';
 import { Address, encodeFunctionData } from 'viem';
 import { Wormhole } from '@wormhole-foundation/sdk-connect';
 import { EvmPlatform } from '@wormhole-foundation/sdk-evm';
+import assert from 'assert';
 import { MrlExtrinsicConfigBuilder } from '../../../ExtrinsicBuilder.interfaces';
 import { ExtrinsicConfig } from '../../../ExtrinsicConfig';
 import { BATCH_CONTRACT_ABI } from './BatchContractAbi';
@@ -26,11 +27,10 @@ export function ethereumXcm() {
         moonChain,
         moonGasLimit,
       }) => {
-        if (!destination.wh?.name) {
-          throw new Error(
-            `Destination chain ${destination.name} does not have a wormhole name`,
-          );
-        }
+        assert(
+          destination.wh?.name,
+          `Destination chain ${destination.name} does not have a wormhole name`,
+        );
 
         const wh = new Wormhole(moonChain.isTestChain ? 'Testnet' : 'Mainnet', [
           EvmPlatform,
@@ -46,11 +46,10 @@ export function ethereumXcm() {
         const tokenAddressOnMoonChain = moonChain.getChainAsset(asset)
           .address as Address | undefined;
 
-        if (!tokenAddressOnMoonChain) {
-          throw new Error(
-            `Asset ${asset.symbol} does not have a token address on chain ${moonChain.name}`,
-          );
-        }
+        assert(
+          tokenAddressOnMoonChain,
+          `Asset ${asset.symbol} does not have a token address on chain ${moonChain.name}`,
+        );
 
         const destinationAddress32bytes = convertAddressTo32Bytes(
           destinationAddress,

diff --git a/packages/builder/src/extrinsic/mrl/wormhole/polkadotXcm/polkadotXcm.ts b/packages/builder/src/extrinsic/mrl/wormhole/polkadotXcm/polkadotXcm.ts
@@ -1,5 +1,6 @@
 import { getMultilocationDerivedAddresses } from '@moonbeam-network/xcm-utils';
 import { AssetAmount } from '@moonbeam-network/xcm-types';
+import assert from 'assert';
 import { ExtrinsicBuilder } from '../../../ExtrinsicBuilder';
 import { MrlExtrinsicConfigBuilder } from '../../../ExtrinsicBuilder.interfaces';
 import { ExtrinsicConfig } from '../../../ExtrinsicConfig';
@@ -22,14 +23,11 @@ export function polkadotXcm() {
           sourceApi,
           transact,
         } = params;
-
-        if (!destination.wh?.name) {
-          throw new Error('Destination chain does not have a wormhole name');
-        }
-
-        if (!transact) {
-          throw new Error('Transact params are required');
-        }
+        assert(transact, 'Transact param is required');
+        assert(
+          destination.wh?.name,
+          `Destination chain ${destination.name} does not have a wormhole name`,
+        );
 
         const { transfer } = sourceApi.tx.xTokens;
         const builder = ExtrinsicBuilder().xTokens().transfer();

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -43,6 +43,7 @@
     "@moonbeam-network/xcm-config": "2.5.3",
     "@moonbeam-network/xcm-types": "2.3.1",
     "@moonbeam-network/xcm-utils": "2.1.4",
+    "assert": "^2.1.0",
     "big.js": "^6.2.1"
   },
   "peerDependencies": {

diff --git a/packages/sdk/src/sdk.ts b/packages/sdk/src/sdk.ts
@@ -7,6 +7,7 @@ import {
   EvmParachain,
   Parachain,
 } from '@moonbeam-network/xcm-types';
+import assert from 'assert';
 import { getAssetsBalances } from './getTransferData/getSourceData';
 import { getTransferData } from './getTransferData/getTransferData';
 import { PolkadotService } from './polkadot';
@@ -52,23 +53,15 @@ export function Sdk({ configService, ecosystem }: SdkOptions = {}) {
                 ): Promise<TransferData> {
                   const sourceChain = service.getChain(source);
 
-                  if (
-                    !Parachain.is(sourceChain) &&
-                    !EvmParachain.is(sourceChain)
-                  ) {
-                    throw new Error(
-                      `Source chain should be a Parachain or EvmParachain`,
-                    );
-                  }
-
-                  if (
-                    !Parachain.is(route.destination) &&
-                    !EvmParachain.is(route.destination)
-                  ) {
-                    throw new Error(
-                      `Destination chain should be a Parachain or EvmParachain`,
-                    );
-                  }
+                  assert(
+                    Parachain.is(sourceChain) || EvmParachain.is(sourceChain),
+                    'Source chain should be a Parachain or EvmParachain',
+                  );
+                  assert(
+                    Parachain.is(route.destination) ||
+                      EvmParachain.is(route.destination),
+                    'Destination chain should be a Parachain or EvmParachain',
+                  );
 
                   return getTransferData({
                     route,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml