prettier & gh actions

Author: douglasgalico

.github/workflows/app.yml

@@ -0,0 +1,10 @@
+name: app
+on: pull_request
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # pinning the commit to v2
+      - run: bun install --frozen-lockfile
+      - run: bun run check

bun.lock

@@ -15,6 +15,7 @@
       "devDependencies": {
         "@types/bun": "latest",
         "@types/cors": "^2.8.17",
+        "prettier": "^3.5.3",
       },
       "peerDependencies": {
         "typescript": "^5",
@@ -178,6 +179,8 @@
 
     "path-to-regexp": ["[email protected]", "", {}, "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ=="],
 
+    "prettier": ["[email protected]", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ=="],
+
     "proxy-addr": ["[email protected]", "", { "dependencies": { "forwarded": "0.2.0", "ipaddr.js": "1.9.1" } }, "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg=="],
 
     "qs": ["[email protected]", "", { "dependencies": { "side-channel": "^1.1.0" } }, "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w=="],

package.json

@@ -5,13 +5,17 @@
   "private": true,
   "devDependencies": {
     "@types/bun": "latest",
-    "@types/cors": "^2.8.17"
+    "@types/cors": "^2.8.17",
+    "prettier": "^3.5.3"
   },
   "peerDependencies": {
     "typescript": "^5"
   },
   "scripts": {
-    "start": "bun src/index.ts"
+    "start": "bun src/index.ts",
+    "check": "bun run type:check && bun run prettier:check",
+    "type:check": "tsc --noEmit",
+    "prettier:check": "prettier . --check"
   },
   "dependencies": {
     "@types/express": "^5.0.3",
@@ -21,5 +25,6 @@
     "cors": "^2.8.5",
     "express": "^5.1.0",
     "viem": "^2.31.7"
-  }
+  },
+  "prettier": {}
 }

src/api/index.ts

@@ -1,3 +1,3 @@
 export { quoteHandler } from "./quote";
 export { statusHandler } from "./status";
-export { capabilitiesHandler } from "./capabilities";
+export { capabilitiesHandler } from "./capabilities";

src/api/quote.ts

@@ -49,8 +49,8 @@ export const quoteHandler = async (req: Request, res: Response) => {
       .status(400)
       .send(
         `Unsupported source chain: ${srcChainId}, supported chains: ${enabledChainIds.join(
-          ","
-        )}`
+          ",",
+        )}`,
       );
     return;
   }
@@ -60,8 +60,8 @@ export const quoteHandler = async (req: Request, res: Response) => {
       .status(400)
       .send(
         `Unsupported destination chain: ${dstChainId}, supported chains: ${enabledChainIds.join(
-          ","
-        )}`
+          ",",
+        )}`,
       );
     return;
   }
@@ -87,7 +87,7 @@ export const quoteHandler = async (req: Request, res: Response) => {
         padHex(PAYEE_PUBLIC_KEY, {
           dir: "left",
           size: 32,
-        })
+        }),
       ),
       srcChain: parseInt(srcChainId),
       dstChain: parseInt(dstChainId),
@@ -116,7 +116,7 @@ export const quoteHandler = async (req: Request, res: Response) => {
       res
         .status(400)
         .send(
-          `Request exceeds maxGasLimit: ${gasLimit.toString()} requested, ${dstChain.capabilities.maxGasLimit.toString()} maximum.`
+          `Request exceeds maxGasLimit: ${gasLimit.toString()} requested, ${dstChain.capabilities.maxGasLimit.toString()} maximum.`,
         );
       return;
     }
@@ -125,7 +125,7 @@ export const quoteHandler = async (req: Request, res: Response) => {
       res
         .status(400)
         .send(
-          `Request exceeds maxMsgValue: ${msgValue.toString()} requested, ${dstChain.capabilities.maxMsgValue.toString()} maximum.`
+          `Request exceeds maxMsgValue: ${msgValue.toString()} requested, ${dstChain.capabilities.maxMsgValue.toString()} maximum.`,
         );
       return;
     }
@@ -136,7 +136,7 @@ export const quoteHandler = async (req: Request, res: Response) => {
       msgValue,
       dstChain.gasPriceDecimals,
       srcChain.nativeDecimals,
-      dstChain.nativeDecimals
+      dstChain.nativeDecimals,
     );
   }
   res.status(200).json(response);

src/consts.ts

@@ -3,7 +3,7 @@ import { mnemonicToAccount } from "viem/accounts";
 
 const account = mnemonicToAccount(
   "test test test test test test test test test test test junk",
-  { addressIndex: 9 }
+  { addressIndex: 9 },
 );
 
 export const PAYEE_PUBLIC_KEY = account.address;

src/index.ts

@@ -11,11 +11,11 @@ BigInt.prototype.toJSON = function () {
 
 await overrideGuardianSet(
   "http://anvil-eth-sepolia:8545",
-  "0x4a8bc80Ed5a4067f1CCf107057b8270E0cC11A78"
+  "0x4a8bc80Ed5a4067f1CCf107057b8270E0cC11A78",
 );
 await overrideGuardianSet(
   "http://anvil-base-sepolia:8545",
-  "0x79A1027a6A159502049F10906D333EC57E95F083"
+  "0x79A1027a6A159502049F10906D333EC57E95F083",
 );
 
 const app = express();

src/mockGuardian.ts

@@ -23,7 +23,7 @@ import { EVM_PRIVATE_KEY } from "./consts";
 async function getWormholeMessage(
   rpc: string,
   txHash: Hex,
-  coreContractAddress: Hex
+  coreContractAddress: Hex,
 ): Promise<VAA<"Uint8Array"> | undefined> {
   console.log(`Mocking guardian signatures for ${rpc} ${txHash}`);
   const transport = http(rpc);
@@ -60,12 +60,12 @@ async function getWormholeMessage(
               blockHash: transaction.blockHash,
               includeTransactions: false,
             })
-          ).timestamp
+          ).timestamp,
         ),
         // NOTE: the Wormhole SDK requires this be a known chain, though that is not strictly necessary for our use case.
         emitterChain: toChain(chainId),
         emitterAddress: new UniversalAddress(
-          toBytes(padHex(emitter, { dir: "left", size: 32 }))
+          toBytes(padHex(emitter, { dir: "left", size: 32 })),
         ),
         consistencyLevel: topic.args.consistencyLevel,
         sequence: topic.args.sequence,
@@ -83,7 +83,7 @@ async function getWormholeMessage(
 export async function mockWormhole(
   rpc: string,
   txHash: Hex,
-  coreContractAddress: Hex
+  coreContractAddress: Hex,
 ): Promise<string> {
   const vaa = await getWormholeMessage(rpc, txHash, coreContractAddress);
   if (vaa) {

src/overrideGuardianSet.ts

@@ -16,7 +16,7 @@ import { EVM_PUBLIC_KEY } from "./consts";
 
 export async function overrideGuardianSet(
   anvilRpcUrl: string,
-  coreContractAddress: Hex
+  coreContractAddress: Hex,
 ) {
   const transport = http(anvilRpcUrl);
   const publicClient = createPublicClient({
@@ -39,7 +39,7 @@ export async function overrideGuardianSet(
     encodeAbiParameters(parseAbiParameters("uint32, bytes32"), [
       guardianSetIndex,
       GUARDIAN_SETS_SLOT,
-    ])
+    ]),
   );
   const firstIndexStorageSlot = BigInt(keccak256(addressesStorageSlot));
   await anvilClient.setStorageAt({
@@ -61,7 +61,7 @@ export async function overrideGuardianSet(
   ]);
   console.log(
     `Overrode guardian set ${guardianSetIndex} of ${anvilRpcUrl} contract ${coreContractAddress} to ${guardianSet.keys.join(
-      ", "
-    )}`
+      ", ",
+    )}`,
   );
 }

src/utils.ts

@@ -22,11 +22,11 @@ export async function signQuote(quote: Quote, privateKey: `0x${string}`) {
 }
 
 export function getTotalGasLimitAndMsgValue(
-  relayInstructionsHex: `0x${string}`
+  relayInstructionsHex: `0x${string}`,
 ) {
   const relayInstructions = deserialize(
     relayInstructionsLayout,
-    fromHex(relayInstructionsHex, "bytes")
+    fromHex(relayInstructionsHex, "bytes"),
   );
 
   return totalGasLimitAndMsgValue(relayInstructions);
@@ -60,44 +60,44 @@ export function estimateQuote(
   msgValue: bigint,
   dstGasPriceDecimals: number,
   srcTokenDecimals: number,
-  dstNativeDecimals: number
+  dstNativeDecimals: number,
 ): bigint {
   const r = 18;
   const srcChainValueForBaseFee = ScaledMath.normalize(
     quote.baseFee,
     SIGNED_QUOTE_DECIMALS,
-    srcTokenDecimals
+    srcTokenDecimals,
   );
 
   const nSrcPrice = ScaledMath.normalize(
     quote.srcPrice,
     SIGNED_QUOTE_DECIMALS,
-    r
+    r,
   );
   const nDstPrice = ScaledMath.normalize(
     quote.dstPrice,
     SIGNED_QUOTE_DECIMALS,
-    r
+    r,
   );
   const scaledConversion = ScaledMath.div(nDstPrice, nSrcPrice, r);
 
   const nGasLimitCost = ScaledMath.normalize(
     gasLimit * quote.dstGasPrice,
     dstGasPriceDecimals,
-    r
+    r,
   );
 
   const srcChainValueForGasLimit = ScaledMath.normalize(
     ScaledMath.mul(nGasLimitCost, scaledConversion, r),
     r,
-    srcTokenDecimals
+    srcTokenDecimals,
   );
 
   const nMsgValue = ScaledMath.normalize(msgValue, dstNativeDecimals, r);
   const srcChainValueForMsgValue = ScaledMath.normalize(
     ScaledMath.mul(nMsgValue, scaledConversion, r),
     r,
-    srcTokenDecimals
+    srcTokenDecimals,
   );
   return (
     srcChainValueForBaseFee +