feat: add test framework (#5)

* format, lint and test scripts.

* format

* logger test

* use cache in CI

.github/workflows/build-lint-test.yml

@@ -0,0 +1,34 @@
+name: Build Lint & Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-lint-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run CI
+        run: pnpm run ci

apps/example/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 2
+}

apps/example/components/ConnectButton.tsx

@@ -27,7 +27,7 @@ export const ConnectButton = ({ className }: ConnectButton) => {
           <div
             className={cn(
               !ready && "pointer-events-none hidden select-none opacity-0",
-              className
+              className,
             )}
             aria-hidden={ready ? "false" : "true"}
           >

apps/example/components/Header.tsx

@@ -10,7 +10,7 @@ export const Header = ({
     <div
       className={cn(
         "fixed top-0 z-20 flex w-full items-center justify-between bg-transparent p-4 md:p-5",
-        className
+        className,
       )}
       {...props}
     >

apps/example/components/ui/button.tsx

@@ -32,7 +32,7 @@ const buttonVariants = cva(
       variant: "ghost",
       size: "default",
     },
-  }
+  },
 );
 
 export type ButtonProps = {
@@ -50,7 +50,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
         {...props}
       />
     );
-  }
+  },
 );
 Button.displayName = "Button";
 

apps/example/components/ui/popover.tsx

@@ -1,13 +1,13 @@
-"use client"
+"use client";
 
-import * as React from "react"
-import * as PopoverPrimitive from "@radix-ui/react-popover"
+import * as React from "react";
+import * as PopoverPrimitive from "@radix-ui/react-popover";
 
-import { cn } from "@/lib/utils"
+import { cn } from "@/lib/utils";
 
-const Popover = PopoverPrimitive.Root
+const Popover = PopoverPrimitive.Root;
 
-const PopoverTrigger = PopoverPrimitive.Trigger
+const PopoverTrigger = PopoverPrimitive.Trigger;
 
 const PopoverContent = React.forwardRef<
   React.ElementRef<typeof PopoverPrimitive.Content>,
@@ -20,12 +20,12 @@ const PopoverContent = React.forwardRef<
       sideOffset={sideOffset}
       className={cn(
         "z-50 w-72 rounded-md border border-slate-200 bg-white p-4 text-slate-950 shadow-md outline-none data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 dark:border-slate-800 dark:bg-slate-950 dark:text-slate-50",
-        className
+        className,
       )}
       {...props}
     />
   </PopoverPrimitive.Portal>
-))
-PopoverContent.displayName = PopoverPrimitive.Content.displayName
+));
+PopoverContent.displayName = PopoverPrimitive.Content.displayName;
 
-export { Popover, PopoverTrigger, PopoverContent }
+export { Popover, PopoverTrigger, PopoverContent };

apps/example/components/ui/tooltip.tsx

@@ -1,15 +1,15 @@
-"use client"
+"use client";
 
-import * as React from "react"
-import * as TooltipPrimitive from "@radix-ui/react-tooltip"
+import * as React from "react";
+import * as TooltipPrimitive from "@radix-ui/react-tooltip";
 
-import { cn } from "@/lib/utils"
+import { cn } from "@/lib/utils";
 
-const TooltipProvider = TooltipPrimitive.Provider
+const TooltipProvider = TooltipPrimitive.Provider;
 
-const Tooltip = TooltipPrimitive.Root
+const Tooltip = TooltipPrimitive.Root;
 
-const TooltipTrigger = TooltipPrimitive.Trigger
+const TooltipTrigger = TooltipPrimitive.Trigger;
 
 const TooltipContent = React.forwardRef<
   React.ElementRef<typeof TooltipPrimitive.Content>,
@@ -20,11 +20,11 @@ const TooltipContent = React.forwardRef<
     sideOffset={sideOffset}
     className={cn(
       "z-50 overflow-hidden rounded-md border border-slate-200 bg-white px-3 py-1.5 text-sm text-slate-950 shadow-md animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 dark:border-slate-800 dark:bg-slate-950 dark:text-slate-50",
-      className
+      className,
     )}
     {...props}
   />
-))
-TooltipContent.displayName = TooltipPrimitive.Content.displayName
+));
+TooltipContent.displayName = TooltipPrimitive.Content.displayName;
 
-export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider }
+export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider };

apps/example/package.json

@@ -7,7 +7,8 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "sdk": "tsx ./scripts/sdk.ts"
+    "sdk": "tsx ./scripts/sdk.ts",
+    "ci": "pnpm run build && pnpm run lint"
   },
   "dependencies": {
     "@across-toolkit/sdk": "workspace:*",
@@ -37,6 +38,7 @@
     "eslint": "^8",
     "eslint-config-next": "14.2.7",
     "postcss": "^8",
+    "prettier": "^3.2.5",
     "tailwindcss": "^3.4.1",
     "tsx": "^4.19.0",
     "typescript": "^5"

package.json

@@ -4,6 +4,8 @@
     "build": "turbo build",
     "dev": "turbo dev",
     "lint": "turbo lint",
+    "test": "turbo test",
+    "ci": "turbo ci",
     "clean": "turbo clean && rm -rf node_modules",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "changeset": "changeset",

packages/sdk/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 2
+}

packages/sdk/package.json

@@ -1,9 +1,25 @@
 {
   "name": "@across-toolkit/sdk",
   "version": "0.0.0",
-  "main": "./dist/index.js",
+  "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
+  "description": "The official SDK for integrating Across bridge into your dapp.",
+  "keywords": [
+    "bridge",
+    "sdk",
+    "crypto",
+    "blockchain"
+  ],
+  "homepage": "https://github.com/across-protocol/toolkit",
+  "bugs": {
+    "url": "https://github.com/across-protocol/toolkit/issues"
+  },
+  "author": "Across Protocol <[email protected]> (https://across.to)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/across-protocol/toolkit.git"
+  },
   "sideEffects": false,
   "license": "MIT",
   "files": [
@@ -13,20 +29,28 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "build": "tsup src/index.ts --format esm --dts",
+    "dev": "tsup src/index.ts --format esm --watch --dts",
     "lint": "pnpm run type-check && eslint \"src/**/*.ts*\"",
+    "format": "prettier --write .",
+    "check-format": "prettier --check .",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc",
+    "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "test": "vitest run",
+    "ci": "pnpm run build && pnpm run check-exports pnpm npm run lint && pnpm run test"
   },
   "devDependencies": {
     "@across-toolkit/eslint-config": "workspace:*",
     "@across-toolkit/typescript-config": "workspace:*",
+    "@arethetypeswrong/cli": "^0.15.4",
     "@types/node": "^20",
     "eslint": "^8.57.0",
+    "prettier": "^3.2.5",
     "tsup": "^8.0.2",
     "typescript": "^5.3.3",
-    "viem": "^2.20.1"
+    "viem": "^2.20.1",
+    "vitest": "^2.0.5"
   },
   "publishConfig": {
     "access": "public"

packages/sdk/src/actions/getAvailableRoutes.ts

@@ -24,7 +24,7 @@ export async function getAvailableRoutes(params?: AvailableRoutesParams) {
   const searchParams = params ? buildSearchParams(params) : "";
 
   const res = await fetchAcross(
-    `${client.apiUrl}/available-routes?${searchParams}`
+    `${client.apiUrl}/available-routes?${searchParams}`,
   );
   const data = (await res.json()) as AvailableRoutesResponse;
 

packages/sdk/src/actions/getSuggestedFees.ts

@@ -21,12 +21,12 @@ export async function getSuggestedFees(params: SuggestedFeesParams) {
     depositMethod: "depositExclusive",
   });
   const res = await fetchAcross(
-    `${client.apiUrl}/suggested-fees?${searchParams}`
+    `${client.apiUrl}/suggested-fees?${searchParams}`,
   );
 
   if (!res.ok) {
     throw new Error(
-      `Failed to fetch suggested fees: ${res.status}, ${await res.text()}`
+      `Failed to fetch suggested fees: ${res.status}, ${await res.text()}`,
     );
   }
 

packages/sdk/src/client.ts

@@ -52,7 +52,7 @@ export class AcrossClient {
 
     this.log.debug(
       "Client created with args: \n",
-      JSON.stringify(args, null, 2)
+      JSON.stringify(args, null, 2),
     );
   }
 
@@ -66,7 +66,7 @@ export class AcrossClient {
   public static getInstance(): AcrossClient {
     if (this.instance === null) {
       throw new Error(
-        "AcrossClient has not been initialized. Call create() first."
+        "AcrossClient has not been initialized. Call create() first.",
       );
     }
     return this.instance;

packages/sdk/src/utils/fetch.ts

@@ -12,7 +12,7 @@ export const fetchAcross = globalThis.fetch.bind(globalThis);
  */
 
 export function buildSearchParams(
-  params: Record<string, number | bigint | string | Array<number | string>>
+  params: Record<string, number | bigint | string | Array<number | string>>,
 ): string {
   const searchParams = new URLSearchParams();
   for (const key in params) {

packages/sdk/test/actions/getAvailableRoutes.test.ts

@@ -0,0 +1,8 @@
+import { expect, test } from "vitest";
+
+function sum(a: number, b: number) {
+  return a + b;
+}
+test("adds 1 + 2 to equal 3", () => {
+  expect(sum(1, 2)).toBe(3);
+});

packages/sdk/test/utils/logger.test.ts

@@ -0,0 +1,30 @@
+import { expect, test, vi } from "vitest";
+import { AcrossClient } from "../../src/client";
+
+const client = AcrossClient.create({
+  useTestnet: true,
+  integratorId: "TEST_ID",
+  logLevel: "WARN",
+});
+
+const consoleErrorSpy = vi.spyOn(console, "error");
+const consoleWarnSpy = vi.spyOn(console, "warn");
+const consoleDebugSpy = vi.spyOn(console, "debug");
+
+test("Lower log level not logged", () => {
+  client.log.error("Should not be logged");
+
+  expect(consoleErrorSpy).not.toHaveBeenCalled();
+});
+
+test("Equal log level is logged", () => {
+  client.log.warn("Should be logged");
+
+  expect(consoleWarnSpy).toHaveBeenCalled();
+});
+
+test("Higher log level is logged", () => {
+  client.log.debug("Should be logged");
+
+  expect(consoleDebugSpy).toHaveBeenCalled();
+});

packages/sdk/tsconfig.json

@@ -3,6 +3,6 @@
   "include": ["."],
   "exclude": ["dist", "build", "node_modules"],
   "compilerOptions": {
-    "module": "NodeNext",
+    "noEmit": true
   }
 }

packages/sdk/tsup.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entryPoints: ["src/index.ts"],
+  format: ["esm"],
+  dts: true,
+  outDir: "dist",
+  clean: true,
+});

packages/typescript-config/base.json

@@ -10,14 +10,16 @@
     "allowImportingTsExtensions": true,
     "inlineSources": false,
     "isolatedModules": true,
-    "module": "ESNext",
+    "module": "NodeNext",
+    "sourceMap": true,
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "preserveWatchOutput": true,
     "skipLibCheck": true,
     "strict": true,
-    "noEmit": true,
-    "strictNullChecks": true
+    "strictNullChecks": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true
   },
   "exclude": ["node_modules"]
 }