Tim/enforce prettier and eslint on precommit (#230)

* chore: add husky precommit hooks to prettier and eslint staged files

* chore: run prettier --write .

.eslintrc.json

@@ -1,10 +1,6 @@
 {
   "root": true,
-  "plugins": [
-    "@typescript-eslint",
-    "import",
-    "prettier"
-  ],
+  "plugins": ["@typescript-eslint", "import", "prettier"],
   "extends": [
     "airbnb-typescript/base",
     "prettier",

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,5 @@
 # 🔘 PR Type
+
 What kind of change does this PR introduce?
 
 <!-- Please check the one that applies to this PR using "x". -->
@@ -12,32 +13,36 @@ What kind of change does this PR introduce?
 - [ ] Documentation content changes
 - [ ] Other... Please describe:
 
-
 # 📜 Background
+
 Provide a brief explanation of why this pull request is needed. Include the problem you are solving or the functionality you are adding. Reference any related issues.
 
 Issue Link: #[issue_number]
 Context Link (if applicable):
 
 # 🔄 Changes
+
 Does this PR introduce a breaking change?
 
 - [ ] Yes, Incompatible API changes
 - [ ] No, Adds functionality (backwards compatible)
 - [ ] No, Bug fixes (backwards compatible)
 
 Changes:
+
 - What has been modified, added, or removed
 - Which are breaking changes
 
 Impact:
+
 - How it improves performance, fixes bugs, adds functionality, etc.
 - Impact on downstream apps, link to issues or PRs for migration
 - What to test
 
 # 🖼 Screenshot / 📹 Video
 
 # ✅ Review checklist
+
 Please ensure the following are true before merging:
 
 - [ ] Code Style is consistent with the project guidelines.

.github/workflows/release-package.yml

@@ -38,6 +38,6 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - run: npm publish
-        if: "!github.event.release.prerelease"
+        if: '!github.event.release.prerelease'
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

README.md

@@ -1,5 +1,6 @@
 # Xverse Core
+
 - Folders are separated according to functionaility e.g. wallet works with getting assets and balances, transaction works with creating transaction objects.
 - Files under `/api` contains functions that are making external API calls, the file name should indicate which service it is calling.
 - All types are under the `types` directory, some are interfaces that maps to API responses, some are data types for business logic.
-- All export should be group and exported using `index.ts`.
+- All export should be group and exported using `index.ts`.

api/btc.ts

@@ -16,11 +16,7 @@ export async function fetchBtcOrdinalTransactions(ordinalsAddress: string, netwo
   return transactions.filter((tx) => tx.incoming);
 }
 
-export async function fetchBtcPaymentTransactions(
-  btcAddress: string,
-  ordinalsAddress: string,
-  network: NetworkType
-) {
+export async function fetchBtcPaymentTransactions(btcAddress: string, ordinalsAddress: string, network: NetworkType) {
   const btcClient = new BitcoinEsploraApiProvider({
     network,
   });
@@ -36,22 +32,14 @@ export async function fetchBtcTransactionsData(
   btcAddress: string,
   ordinalsAddress: string,
   network: NetworkType,
-  withOrdinals: boolean
+  withOrdinals: boolean,
 ): Promise<BtcTransactionData[]> {
   if (withOrdinals) {
     const ordinalsTransactions = await fetchBtcOrdinalTransactions(ordinalsAddress, network);
-    const paymentTransactions = await fetchBtcPaymentTransactions(
-      btcAddress,
-      ordinalsAddress,
-      network
-    );
+    const paymentTransactions = await fetchBtcPaymentTransactions(btcAddress, ordinalsAddress, network);
     return [...new Set([...paymentTransactions, ...ordinalsTransactions])];
   }
-  const paymentTransactions = await fetchBtcPaymentTransactions(
-    btcAddress,
-    ordinalsAddress,
-    network
-  );
+  const paymentTransactions = await fetchBtcPaymentTransactions(btcAddress, ordinalsAddress, network);
   return paymentTransactions;
 }
 

api/esplora/esploraAPiProvider.ts

@@ -57,7 +57,7 @@ export default class BitcoinEsploraApiProvider extends ApiInstance implements Bi
   }
 
   private async getUtxosEsplora(
-    address: string
+    address: string,
   ): Promise<(esplora.UTXO & { address: string; blockHeight?: number })[]> {
     const data = await this.httpGet<esplora.UTXO[]>(`/address/${address}/utxo`);
 
@@ -71,7 +71,7 @@ export default class BitcoinEsploraApiProvider extends ApiInstance implements Bi
   }
 
   private async getUtxosBlockcypher(
-    address: string
+    address: string,
   ): Promise<(esplora.UTXO & { address: string; blockHeight?: number })[]> {
     // blockcypher has a limit of 2000 UTXOs per request and allows pagination
     // so we will try get all unspent UTXOs by making multiple requests if there are more than 2000
@@ -115,9 +115,7 @@ export default class BitcoinEsploraApiProvider extends ApiInstance implements Bi
     return utxoSets;
   }
 
-  async getUnspentUtxos(
-    address: string
-  ): Promise<(esplora.UTXO & { address: string; blockHeight?: number })[]> {
+  async getUnspentUtxos(address: string): Promise<(esplora.UTXO & { address: string; blockHeight?: number })[]> {
     try {
       // we try using the base esplora api first, however, it has a limit to the number of UTXOs it can return
       const utxoSets = await this.getUtxosEsplora(address);

api/esplora/types.ts

@@ -1,4 +1,4 @@
-import { BtcAddressData, BtcTransactionBroadcastResponse } from "../../types";
+import { BtcAddressData, BtcTransactionBroadcastResponse } from '../../types';
 import { BtcAddressMempool, Transaction, UTXO } from '../../types/api/esplora';
 export interface BitcoinApiProvider {
   /**
@@ -42,4 +42,4 @@ export interface BitcoinApiProvider {
    * @returns {Promise<number>}
    */
   getLatestBlockHeight(address: string): Promise<number>;
-}
+}

api/gamma.ts

@@ -5,7 +5,7 @@ import { NFT_BASE_URI } from '../constant';
 export async function getNftDetail(
   tokenId: string,
   contractAddress: string,
-  contractName: string
+  contractName: string,
 ): Promise<NftDetailResponse> {
   const apiUrl = `${NFT_BASE_URI}/${contractAddress}.${contractName}/${tokenId}`;
 

api/index.ts

@@ -4,4 +4,4 @@ export * from './stacks';
 export * from './gamma';
 export * from './ordinals';
 export * from './esplora/esploraAPiProvider';
-export * from './ordinals/provider';
+export * from './ordinals/provider';

api/ordinals/types.ts

@@ -1,6 +1,5 @@
 import { Inscription, InscriptionsList } from '../../types/api/ordinals';
 
-
 export interface OrdinalsApiProvider {
   /**
    * Get the inscriptions of an account given its addresses.

api/stacks.ts

@@ -357,7 +357,6 @@ export async function fetchAddressOfBnsName(
 }
 
 export async function fetchStxPendingTxData(stxAddress: string, network: StacksNetwork): Promise<StxPendingTxData> {
-
   const [confirmedTransactions, mempoolTransactions] = await Promise.all([
     getConfirmedTransactions({
       stxAddress,

coins/index.ts

@@ -3,10 +3,7 @@ import { fetchCoinMetaData } from '../api';
 import { supportedCoins } from '../constant';
 import { Coin, CoinMetaData, CoinsResponse } from '../types/index';
 
-export async function getCoinMetaData(
-  contractIds: string[],
-  network: StacksNetwork
-): Promise<CoinsResponse> {
+export async function getCoinMetaData(contractIds: string[], network: StacksNetwork): Promise<CoinsResponse> {
   const coinMetaDataList = contractIds.map(async (contract) => {
     const response: CoinMetaData | undefined = await fetchCoinMetaData(contract, network);
     let coin: Coin;
@@ -28,9 +25,7 @@ export async function getCoinMetaData(
       };
       if (coin.name === '') coin.name = contract.substring(coin.contract.indexOf('.') + 1);
     }
-    const isSupported = supportedCoins.find(
-      (supportedCoin) => supportedCoin.contract === coin.contract
-    );
+    const isSupported = supportedCoins.find((supportedCoin) => supportedCoin.contract === coin.contract);
     if (isSupported) {
       coin.supported = true;
       coin.name = isSupported.name;

currency/index.ts

@@ -9,20 +9,14 @@ const microstacksToStx = (microstacks: BigNumber): BigNumber => microstacks.mult
 
 const stxToMicrostacks = (stacks: BigNumber): BigNumber => stacks.multipliedBy(1000000);
 
-const getStxFiatEquivalent = (
-  stxAmount: BigNumber,
-  stxBtcRate: BigNumber,
-  btcFiatRate: BigNumber
-): BigNumber => microstacksToStx(stxAmount).multipliedBy(stxBtcRate).multipliedBy(btcFiatRate);
+const getStxFiatEquivalent = (stxAmount: BigNumber, stxBtcRate: BigNumber, btcFiatRate: BigNumber): BigNumber =>
+  microstacksToStx(stxAmount).multipliedBy(stxBtcRate).multipliedBy(btcFiatRate);
 
 const getBtcFiatEquivalent = (btcAmount: BigNumber, btcFiatRate: BigNumber): BigNumber =>
   satsToBtc(btcAmount).multipliedBy(btcFiatRate);
 
-const getStxTokenEquivalent = (
-  fiatAmount: BigNumber,
-  stxBtcRate: BigNumber,
-  btcFiatRate: BigNumber
-): BigNumber => fiatAmount.dividedBy(stxBtcRate).dividedBy(btcFiatRate);
+const getStxTokenEquivalent = (fiatAmount: BigNumber, stxBtcRate: BigNumber, btcFiatRate: BigNumber): BigNumber =>
+  fiatAmount.dividedBy(stxBtcRate).dividedBy(btcFiatRate);
 
 const getBtcEquivalent = (fiatAmount: BigNumber, btcFiatRate: BigNumber): BigNumber =>
   fiatAmount.dividedBy(btcFiatRate);

gaia/index.ts

@@ -1,14 +1,13 @@
-import { getPublicKeyFromPrivate, publicKeyToBtcAddress, randomBytes } from "@stacks/encryption";
-import { createFetchFn } from "@stacks/network";
-import { GaiaHubConfig } from "@stacks/storage";
+import { getPublicKeyFromPrivate, publicKeyToBtcAddress, randomBytes } from '@stacks/encryption';
+import { createFetchFn } from '@stacks/network';
+import { GaiaHubConfig } from '@stacks/storage';
 import { Json, TokenSigner } from 'jsontokens';
 
 interface HubInfo {
   challenge_text?: string;
   read_url_prefix: string;
 }
 
-
 export type FetchFn = (url: string, init?: RequestInit) => Promise<Response>;
 
 export const getHubInfo = async (gaiaHubUrl: string, fetchFn: FetchFn = createFetchFn()) => {
@@ -17,7 +16,6 @@ export const getHubInfo = async (gaiaHubUrl: string, fetchFn: FetchFn = createFe
   return data;
 };
 
-
 interface GaiaAuthPayload {
   gaiaHubUrl: string;
   iss: string;
@@ -50,7 +48,6 @@ const makeGaiaAuthToken = ({
   return `v1:${token}`;
 };
 
-
 interface ConnectToGaiaOptions {
   hubInfo: HubInfo;
   privateKey: string;
@@ -74,5 +71,4 @@ export const connectToGaiaHubWithConfig = ({
   };
 };
 
-
 export * from './walletConfig';

jest.config.js

@@ -2,5 +2,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  testPathIgnorePatterns: ['dist']
+  testPathIgnorePatterns: ['dist'],
 };