feat: add TS linting check in CI (#350)

- fixes existing ts linting errors - closes #346 --------- Co-authored-by: Mad <[email protected]>
FuelLabs · Oct 28, 2024 · 6315bbb · 6315bbb
1 parent 9399453
commit 6315bbb
Show file tree

Hide file tree

Showing 57 changed files with 203 additions and 173 deletions.
diff --git a/.changeset/small-singers-attend.md b/.changeset/small-singers-attend.md
@@ -0,0 +1,6 @@
+---
+'@fuel-bridge/solidity-contracts': patch
+'@fuel-bridge/test-utils': patch
+---
+
+ts linting for test packages
diff --git a/.eslintignore b/.eslintignore
@@ -4,3 +4,4 @@
 **/typechain/
 docker/l1-chain/hardhat
 dist
+**/exports/
diff --git a/packages/integration-tests/tests/bridge_erc20.ts b/packages/integration-tests/tests/bridge_erc20.ts
@@ -642,7 +642,7 @@ describe('Bridging ERC20 tokens', async function () {
 
     it('Rate limit parameters are updated when current withdrawn amount is more than the new limit & set a new higher limit', async () => {
       const deployer = await env.eth.deployer;
-      let newRateLimit = '5';
+      const newRateLimit = '5';
 
       let withdrawnAmountBeforeReset =
         await env.eth.fuelERC20Gateway.currentPeriodAmount(

diff --git a/packages/integration-tests/tests/bridge_mainnet_tokens.ts b/packages/integration-tests/tests/bridge_mainnet_tokens.ts
@@ -2,19 +2,19 @@ import type { BridgeFungibleToken } from '@fuel-bridge/fungible-token';
 import {
   RATE_LIMIT_AMOUNT,
   RATE_LIMIT_DURATION,
+  USDT_ADDRESS,
+  USDC_ADDRESS,
+  WBTC_ADDRESS,
+  WETH_ADDRESS,
 } from '@fuel-bridge/solidity-contracts/protocol/constants';
-import {
+import type {
   CustomToken,
   CustomTokenWETH,
+} from '@fuel-bridge/solidity-contracts/typechain';
+import {
   CustomToken__factory,
   CustomTokenWETH__factory,
 } from '@fuel-bridge/solidity-contracts/typechain';
-import {
-  USDT_ADDRESS,
-  USDC_ADDRESS,
-  WBTC_ADDRESS,
-  WETH_ADDRESS,
-} from '@fuel-bridge/solidity-contracts/protocol/constants';
 import type { TestEnvironment } from '@fuel-bridge/test-utils';
 import {
   setupEnvironment,
@@ -89,8 +89,7 @@ describe('Bridge mainnet tokens', function () {
       fuel_AssetId
     );
 
-    let transactionRequest;
-    transactionRequest = await fuel_bridge.functions
+    const transactionRequest = await fuel_bridge.functions
       .withdraw(paddedAddress)
       .addContracts([fuel_bridge, fuel_bridgeImpl])
       .txParams({
@@ -232,7 +231,6 @@ describe('Bridge mainnet tokens', function () {
         const NUM_TOKENS = 100000000000000000000n;
         let ethereumTokenSender: Signer;
         let ethereumTokenSenderAddress: string;
-        let ethereumTokenSenderBalance: bigint;
         let fuelTokenReceiver: FuelWallet;
         let fuelTokenReceiverAddress: string;
         let fuelTokenReceiverBalance: BN;
@@ -247,20 +245,12 @@ describe('Bridge mainnet tokens', function () {
             await weth_testToken
               .connect(ethereumTokenSender)
               .deposit({ value: NUM_TOKENS });
-
-            ethereumTokenSenderBalance = await weth_testToken.balanceOf(
-              ethereumTokenSenderAddress
-            );
           } else {
             const mintAmount =
               BigInt(NUM_TOKENS) / 10n ** (18n - decimals[index]);
             await customToken
               .mint(ethereumTokenSender, mintAmount)
               .then((tx) => tx.wait());
-
-            ethereumTokenSenderBalance = await customToken.balanceOf(
-              ethereumTokenSenderAddress
-            );
           }
 
           fuelTokenReceiver = env.fuel.signers[0];
@@ -302,10 +292,10 @@ describe('Bridge mainnet tokens', function () {
 
           fuelTokenMessageNonce = new BN(event.args.nonce.toString());
 
-          let newSenderBalance;
-
           // check that the sender balance has decreased by the expected amount
-          newSenderBalance = await token.balanceOf(ethereumTokenSenderAddress);
+          const newSenderBalance = await token.balanceOf(
+            ethereumTokenSenderAddress
+          );
 
           expect(newSenderBalance === 0n).to.be.true;
         });
@@ -315,15 +305,15 @@ describe('Bridge mainnet tokens', function () {
           this.timeout(FUEL_MESSAGE_TIMEOUT_MS);
 
           // relay the message ourselves
-          let message = await waitForMessage(
+          const message = await waitForMessage(
             env.fuel.provider,
             fuelTokenMessageReceiver,
             fuelTokenMessageNonce,
             FUEL_MESSAGE_TIMEOUT_MS
           );
           expect(message).to.not.be.null;
 
-          let tx = await relayCommonMessage(env.fuel.deployer, message, {
+          const tx = await relayCommonMessage(env.fuel.deployer, message, {
             gasLimit: 30000000,
             maturity: undefined,
             contractIds: [fuel_bridgeImpl.id.toHexString()],

diff --git a/packages/integration-tests/tests/bridge_proxy.ts b/packages/integration-tests/tests/bridge_proxy.ts
@@ -1,8 +1,8 @@
+import type { Proxy } from '@fuel-bridge/fungible-token';
 import type { TestEnvironment } from '@fuel-bridge/test-utils';
 import { setupEnvironment, getOrDeployL2Bridge } from '@fuel-bridge/test-utils';
 import chai from 'chai';
 import type { Contract, FuelError } from 'fuels';
-import { Proxy } from '@fuel-bridge/fungible-token';
 
 const { expect } = chai;
 

diff --git a/packages/integration-tests/tests/transfer_eth.ts b/packages/integration-tests/tests/transfer_eth.ts
@@ -1,5 +1,5 @@
+import type { TestEnvironment } from '@fuel-bridge/test-utils';
 import {
-  TestEnvironment,
   setupEnvironment,
   fuels_parseEther,
   createRelayMessageParams,
@@ -14,9 +14,8 @@ import {
   hardhatSkipTime,
 } from '@fuel-bridge/test-utils';
 import chai from 'chai';
-import type { Signer } from 'ethers';
 import { parseEther } from 'ethers';
-import type { JsonRpcProvider } from 'ethers';
+import type { Signer, JsonRpcProvider } from 'ethers';
 import { Address, BN, padFirst12BytesOfEvmAddress } from 'fuels';
 import type {
   AbstractAddress,
@@ -264,6 +263,8 @@ describe('Transferring ETH', async function () {
       // withdraw ETH back to the base chain
       const blocksPerCommitInterval =
         await env.eth.fuelChainState.BLOCKS_PER_COMMIT_INTERVAL();
+
+      // eslint-disable-next-line no-constant-condition
       while (true) {
         const currentBlock = await env.fuel.provider.getBlockNumber();
         debug(`Current block ${currentBlock.toString()}`);
@@ -349,7 +350,7 @@ describe('Transferring ETH', async function () {
   });
 
   describe('ETH Withdrawls based on rate limit updates', async () => {
-    let NUM_ETH = '9';
+    const NUM_ETH = '9';
     const largeRateLimit = `30`;
     let fuelETHSender: FuelWallet;
     let ethereumETHReceiver: Signer;

diff --git a/packages/solidity-contracts/deploy/hardhat/008.set_canonical_token_bytecode.ts b/packages/solidity-contracts/deploy/hardhat/008.set_canonical_token_bytecode.ts
@@ -1,5 +1,6 @@
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
+
 import {
   USDT_ADDRESS,
   USDC_ADDRESS,

diff --git a/packages/solidity-contracts/deploy/mainnet/002.fuel_message_portal_v3.ts b/packages/solidity-contracts/deploy/mainnet/002.fuel_message_portal_v3.ts
@@ -2,12 +2,11 @@ import { MaxUint256 } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
 
-import { FuelMessagePortalV3__factory as FuelMessagePortal } from '../../typechain';
-
 import {
   RATE_LIMIT_AMOUNT,
   RATE_LIMIT_DURATION,
 } from '../../protocol/constants';
+import { FuelMessagePortalV3__factory as FuelMessagePortal } from '../../typechain';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {

diff --git a/packages/solidity-contracts/deploy/mainnet/009.gateway_add_usdc.ts b/packages/solidity-contracts/deploy/mainnet/009.gateway_add_usdc.ts
@@ -1,6 +1,6 @@
+import { parseUnits } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
-import { parseUnits } from 'ethers';
 
 const USDC_ADDRESS = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 

diff --git a/packages/solidity-contracts/deploy/mainnet/010.gateway_rate_limit_usdc.ts b/packages/solidity-contracts/deploy/mainnet/010.gateway_rate_limit_usdc.ts
@@ -1,6 +1,6 @@
+import { parseUnits } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
-import { parseUnits } from 'ethers';
 
 const USDC_ADDRESS = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 const ONE_WEEK_IN_SECONDS = 3600 * 24 * 7;

diff --git a/packages/solidity-contracts/deploy/mainnet/012.portal_transfer_ownership.ts b/packages/solidity-contracts/deploy/mainnet/012.portal_transfer_ownership.ts
@@ -1,8 +1,9 @@
 import { ZeroHash as DEFAULT_ADMIN_ROLE } from 'ethers';
-import { DeployFunction } from 'hardhat-deploy/dist/types';
-import { HardhatRuntimeEnvironment } from 'hardhat/types';
-import { FuelMessagePortalV3__factory } from '../../typechain';
+import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeployFunction } from 'hardhat-deploy/dist/types';
+
 import { MAINNET_MULTISIG_ADDRESS } from '../../protocol/constants';
+import { FuelMessagePortalV3__factory } from '../../typechain';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { ethers, deployments } = hre;

diff --git a/packages/solidity-contracts/deploy/mainnet/013.chain_state_transfer_ownership.ts b/packages/solidity-contracts/deploy/mainnet/013.chain_state_transfer_ownership.ts
@@ -1,8 +1,9 @@
 import { ZeroHash as DEFAULT_ADMIN_ROLE } from 'ethers';
-import { DeployFunction } from 'hardhat-deploy/dist/types';
-import { HardhatRuntimeEnvironment } from 'hardhat/types';
-import { FuelChainState__factory } from '../../typechain';
+import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeployFunction } from 'hardhat-deploy/dist/types';
+
 import { MAINNET_MULTISIG_ADDRESS } from '../../protocol/constants';
+import { FuelChainState__factory } from '../../typechain';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { ethers, deployments } = hre;

diff --git a/packages/solidity-contracts/deploy/mainnet/014.gateway_transfer_ownership.ts b/packages/solidity-contracts/deploy/mainnet/014.gateway_transfer_ownership.ts
@@ -1,8 +1,9 @@
 import { ZeroHash as DEFAULT_ADMIN_ROLE } from 'ethers';
-import { DeployFunction } from 'hardhat-deploy/dist/types';
-import { HardhatRuntimeEnvironment } from 'hardhat/types';
-import { FuelERC20GatewayV4__factory } from '../../typechain';
+import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeployFunction } from 'hardhat-deploy/dist/types';
+
 import { MAINNET_MULTISIG_ADDRESS } from '../../protocol/constants';
+import { FuelERC20GatewayV4__factory } from '../../typechain';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { ethers, deployments } = hre;

diff --git a/packages/solidity-contracts/deploy/mainnet/015.relinquish_ownership.ts b/packages/solidity-contracts/deploy/mainnet/015.relinquish_ownership.ts
@@ -1,6 +1,7 @@
 import { ZeroHash as DEFAULT_ADMIN_ROLE } from 'ethers';
-import { DeployFunction } from 'hardhat-deploy/dist/types';
-import { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeployFunction } from 'hardhat-deploy/dist/types';
+
 import {
   FuelChainState__factory,
   FuelERC20GatewayV4__factory,

diff --git a/packages/solidity-contracts/deploy/mainnet/016.gateway_upgrade.ts b/packages/solidity-contracts/deploy/mainnet/016.gateway_upgrade.ts
@@ -1,14 +1,14 @@
-import { TransactionResponse } from 'ethers';
+import { password } from '@inquirer/prompts';
+import type { TransactionResponse } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
 
 import { FuelERC20GatewayV4__factory } from '../../typechain';
-import { password } from '@inquirer/prompts';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {
     ethers,
-    upgrades: { prepareUpgrade, upgradeProxy, erc1967 },
+    upgrades: { prepareUpgrade },
     deployments: { get, save },
   } = hre;
 
@@ -22,7 +22,12 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     getTxResponse: true,
   })) as TransactionResponse;
   const receipt = await tx.wait();
-  const implementation = receipt?.contractAddress!;
+  const implementation = receipt?.contractAddress ?? '';
+
+  if (implementation === '')
+    throw new Error(
+      `Upgrade proposal failed for FuelERC20GatewayV4 proxy (${address})`
+    );
 
   console.log(`Proposed FuelERC20GatewayV4 upgrade to ${implementation}`);
   await save('FuelERC20GatewayV4', {

diff --git a/packages/solidity-contracts/deploy/mainnet/017.portal_upgrade.ts b/packages/solidity-contracts/deploy/mainnet/017.portal_upgrade.ts
@@ -1,9 +1,10 @@
-import { TransactionResponse, parseEther } from 'ethers';
+import { password } from '@inquirer/prompts';
+import type { TransactionResponse } from 'ethers';
+import { parseEther } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
 
 import { FuelMessagePortalV3__factory as FuelMessagePortal } from '../../typechain';
-import { password } from '@inquirer/prompts';
 
 const RATE_LIMIT_DURATION = 3600 * 24 * 7;
 
@@ -30,7 +31,12 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   })) as TransactionResponse;
   const receipt = await tx.wait();
 
-  const implementation = receipt?.contractAddress!;
+  const implementation = receipt?.contractAddress ?? '';
+
+  if (implementation === '')
+    throw new Error(
+      `Upgrade proposal failed for FuelMessagePortal proxy (${address})`
+    );
 
   console.log('Proposed FuelMessagePortal upgrade to', implementation);
   await save('FuelMessagePortal', {

diff --git a/packages/solidity-contracts/deploy/mainnet/018.rate_limit_proposal.ts b/packages/solidity-contracts/deploy/mainnet/018.rate_limit_proposal.ts
@@ -1,16 +1,15 @@
+import { password } from '@inquirer/prompts';
+import SafeApiKit from '@safe-global/api-kit';
+import SafeProtocolKit from '@safe-global/protocol-kit';
+import type { MetaTransactionData } from '@safe-global/safe-core-sdk-types';
 import type {
   HardhatRuntimeEnvironment,
   HttpNetworkConfig,
 } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
-import SafeProtocolKit from '@safe-global/protocol-kit';
-import SafeApiKit from '@safe-global/api-kit';
 
-import { MetaTransactionData } from '@safe-global/safe-core-sdk-types';
-
-import { password } from '@inquirer/prompts';
-import { FuelERC20GatewayV4__factory } from '../../typechain';
 import { MAINNET_MULTISIG_ADDRESS } from '../../protocol/constants';
+import { FuelERC20GatewayV4__factory } from '../../typechain';
 
 const MAINNET_TOKENS = [
   '0x4041381e947CFD3D483d67a25C6aa9Dc924250c5',

diff --git a/packages/solidity-contracts/deploy/mainnet/019.pausers_proposal.ts b/packages/solidity-contracts/deploy/mainnet/019.pausers_proposal.ts
@@ -1,16 +1,15 @@
+import { password } from '@inquirer/prompts';
+import SafeApiKit from '@safe-global/api-kit';
+import SafeProtocolKit from '@safe-global/protocol-kit';
+import type { MetaTransactionData } from '@safe-global/safe-core-sdk-types';
 import type {
   HardhatRuntimeEnvironment,
   HttpNetworkConfig,
 } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
-import SafeProtocolKit from '@safe-global/protocol-kit';
-import SafeApiKit from '@safe-global/api-kit';
 
-import { MetaTransactionData } from '@safe-global/safe-core-sdk-types';
-
-import { password } from '@inquirer/prompts';
-import { FuelMessagePortalV3__factory } from '../../typechain';
 import { MAINNET_MULTISIG_ADDRESS } from '../../protocol/constants';
+import { FuelMessagePortalV3__factory } from '../../typechain';
 
 const PAUSERS = [
   '0x958470a2ADe72b7a01A2e160F3286767b9623Ad7',

diff --git a/packages/solidity-contracts/deploy/upgradeTest/prepareUpgrade.chain_state.ts b/packages/solidity-contracts/deploy/upgradeTest/prepareUpgrade.chain_state.ts
@@ -1,8 +1,8 @@
+import type { TransactionResponse } from 'ethers';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeployFunction } from 'hardhat-deploy/dist/types';
 
 import { FuelChainState__factory as FuelChainState } from '../../typechain';
-import { TransactionResponse } from 'ethers';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {
@@ -25,10 +25,17 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     response.hash
   );
 
+  const implementation = receipt?.contractAddress ?? '';
+
+  if (implementation === '')
+    throw new Error(
+      `Upgrade proposal failed for FuelChainState proxy (${contractDeployment.address})`
+    );
+
   await save('FuelChainState', {
     address: contractDeployment.address,
     abi: [...FuelChainState.abi],
-    implementation: receipt?.contractAddress!,
+    implementation,
     transactionHash: response.hash,
     linkedData: {
       constructorArgs: contractDeployment.linkedData.constructorArgs,