Add lint command (#29)

* Add eslint script command

* Fix eslint warnings

* Fix lint-staged config

.eslintrc.json

@@ -1,9 +1,18 @@
 {
   "extends": ["bloq", "prettier"],
+  "ignorePatterns": ["_esm/*", "_types/*"],
   "overrides": [
     {
       "extends": ["bloq/typescript", "prettier"],
-      "files": ["*.ts"]
+      "files": ["src/**/*.ts"],
+      "rules": {
+        "camelcase": [
+          "off",
+          {
+            "allow": ["btc_", "l2_"]
+          }
+        ]
+      }
     },
     {
       "extends": ["bloq/markdown"],

.gitignore

@@ -1,6 +1,7 @@
 _esm
 _types
 .DS_Store
+.eslintcache
 .vscode
 node_modules
 tsconfig.tsbuildinfo

.lintstagedrc.json

@@ -1,4 +1,5 @@
 {
-  "!(package.json)": ["prettier --ignore-unknown --write"],
+  "!(*.{js,md,ts,tsx,yml}|package.json)": ["prettier --ignore-unknown --write"],
+  "*.{js,md,ts,tsx,yml}": ["eslint --cache --fix --quiet", "prettier --write"],
   "package.json": ["better-sort-package-json", "prettier --write"]
 }

package.json

@@ -30,6 +30,7 @@
     "clean": "rm -rf ./_esm ./_types",
     "deps:check": "knip",
     "format:check": "prettier --check .",
+    "lint": "eslint --cache .",
     "prepublishOnly": "npm run build",
     "tsc": "tsc --noEmit"
   },

src/actions/public/bitcoin-kit.ts

@@ -12,31 +12,30 @@ export function getBitcoinAddressBalance(
 ) {
   const { btcAddress } = parameters;
   return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
     abi: bitcoinKitTxsAbi,
-    functionName: "getBitcoinAddressBalance",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [btcAddress],
+    functionName: "getBitcoinAddressBalance",
   });
 }
 
 export function getHeaderN(client: Client, parameters: { height: number }) {
   const { height } = parameters;
   return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
     abi: bitcoinKitTxsAbi,
-    functionName: "getHeaderN",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [height],
+    functionName: "getHeaderN",
   });
 }
 
-export function getLastHeader(client: Client) {
-  return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
+export const getLastHeader = (client: Client) =>
+  readContract(client, {
     abi: bitcoinKitTxsAbi,
-    functionName: "getLastHeader",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [],
+    functionName: "getLastHeader",
   });
-}
 
 export function getTransactionByTxId(
   client: Client,
@@ -45,20 +44,20 @@ export function getTransactionByTxId(
   const { txId } = parameters;
   const hash: Hash = isHash(txId) ? txId : `0x${txId}`;
   return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
     abi: bitcoinKitTxsAbi,
-    functionName: "getTransactionByTxId",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [hash],
+    functionName: "getTransactionByTxId",
   });
 }
 
 export function getTxConfirmations(client: Client, parameters: { txId: Hash }) {
   const { txId } = parameters;
   return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
     abi: bitcoinKitTxsAbi,
-    functionName: "getTxConfirmations",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [txId],
+    functionName: "getTxConfirmations",
   });
 }
 
@@ -68,9 +67,9 @@ export function getUtxosForBitcoinAddress(
 ) {
   const { btcAddress, pageNumber, pageSize } = parameters;
   return readContract(client, {
-    address: bitcoinKitTxAddresses[client.chain!.id],
     abi: bitcoinKitTxsAbi,
-    functionName: "getUTXOsForBitcoinAddress",
+    address: bitcoinKitTxAddresses[client.chain!.id],
     args: [btcAddress, pageNumber, pageSize],
+    functionName: "getUTXOsForBitcoinAddress",
   });
 }

src/actions/public/bitcoin-tunnel-manager.ts

@@ -25,8 +25,8 @@ export function getVaultAddressByOwner(
 ) {
   const { ownerAddress } = parameters;
   return readContract(client, {
-    address: bitcoinTunnelManagerAddresses[client.chain!.id],
     abi: bitcoinTunnelManagerAbi,
+    address: bitcoinTunnelManagerAddresses[client.chain!.id],
     args: [ownerAddress],
     functionName: "getVaultAddressByOwner",
   });

src/actions/public/bitcoin-vault.ts

@@ -10,10 +10,10 @@ export function acknowledgedDeposits(
   const { txId, vaultAddress } = parameters;
   const hash: Hash = isHash(txId) ? txId : `0x${txId}`;
   return readContract(client, {
-    address: vaultAddress,
     abi: bitcoinVaultAbi,
-    functionName: "acknowledgedDeposits",
+    address: vaultAddress,
     args: [hash],
+    functionName: "acknowledgedDeposits",
   });
 }
 
@@ -23,9 +23,9 @@ export function getBitcoinCustodyAddress(
 ) {
   const { vaultAddress } = parameters;
   return readContract(client, {
-    address: vaultAddress,
     abi: bitcoinVaultAbi,
-    functionName: "getBitcoinCustodyAddress",
+    address: vaultAddress,
     args: [],
+    functionName: "getBitcoinCustodyAddress",
   });
 }

src/actions/public/get-btc-finality-by-block-hash.ts

@@ -21,10 +21,10 @@ export async function getBtcFinalityByBlockHash(
       throw err;
     }
     return {
-      l2_keystone: null,
-      btc_pub_height: -1,
-      btc_pub_header_hash: "",
       btc_finality: -9,
+      btc_pub_header_hash: "",
+      btc_pub_height: -1,
+      l2_keystone: null,
     };
   }
 }

src/chains/hemi-sepolia.ts

@@ -5,22 +5,6 @@ const sourceId = 11_155_111; // Sepolia
 
 export const hemiSepolia = defineChain({
   ...chainConfig,
-  id: 743_111,
-  name: "Hemi Sepolia",
-  nativeCurrency: {
-    decimals: 18,
-    name: "Ether",
-    symbol: "ETH",
-  },
-  rpcUrls: {
-    default: {
-      http: ["https://testnet.rpc.hemi.network/rpc"],
-      webSocket: ["wss://testnet.rpc.hemi.network/wsrpc"],
-    },
-    opNode: {
-      http: ["https://testnet.rpc.hemi.network/noderpc"],
-    },
-  },
   blockExplorers: {
     default: {
       name: "Hemi Sepolia Explorer",
@@ -63,6 +47,22 @@ export const hemiSepolia = defineChain({
       },
     },
   },
-  testnet: true,
+  id: 743_111,
+  name: "Hemi Sepolia",
+  nativeCurrency: {
+    decimals: 18,
+    name: "Ether",
+    symbol: "ETH",
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://testnet.rpc.hemi.network/rpc"],
+      webSocket: ["wss://testnet.rpc.hemi.network/wsrpc"],
+    },
+    opNode: {
+      http: ["https://testnet.rpc.hemi.network/noderpc"],
+    },
+  },
   sourceId,
+  testnet: true,
 });

src/chains/hemi.ts

@@ -5,22 +5,6 @@ const sourceId = 1; // Ethereum mainnet
 
 export const hemi = defineChain({
   ...chainConfig,
-  id: 43_111,
-  name: "Hemi Network",
-  nativeCurrency: {
-    decimals: 18,
-    name: "Ether",
-    symbol: "ETH",
-  },
-  rpcUrls: {
-    default: {
-      http: ["https://rpc.hemi.network/rpc"],
-      webSocket: ["wss://rpc.hemi.network/wsrpc"],
-    },
-    opNode: {
-      http: ["https://rpc.hemi.network/noderpc"],
-    },
-  },
   blockExplorers: {
     default: {
       name: "Hemi Network Explorer",
@@ -63,6 +47,22 @@ export const hemi = defineChain({
       },
     },
   },
+  id: 43_111,
+  name: "Hemi Network",
+  nativeCurrency: {
+    decimals: 18,
+    name: "Ether",
+    symbol: "ETH",
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://rpc.hemi.network/rpc"],
+      webSocket: ["wss://rpc.hemi.network/wsrpc"],
+    },
+    opNode: {
+      http: ["https://rpc.hemi.network/noderpc"],
+    },
+  },
   sourceId,
   testnet: false,
 });

src/decorators/actions-to-decorator.ts

@@ -9,16 +9,13 @@ type DecoratedActions<T extends Actions> = {
   [K in keyof T]: (properties: Parameters<T[K]>[1]) => ReturnType<T[K]>;
 };
 
-export const actionsToDecorator = function <TActions extends Actions>(
-  actions: TActions,
-) {
-  return function (client: Client) {
-    return Object.fromEntries(
+export const actionsToDecorator =
+  <TActions extends Actions>(actions: TActions) =>
+  (client: Client) =>
+    Object.fromEntries(
       Object.keys(actions).map((action) => [
         action,
         (properties: Parameters<TActions[typeof action]>[1]) =>
           actions[action](client, properties),
       ]),
     ) as DecoratedActions<TActions>;
-  };
-};