feat: migrate to vitest and merry in gardenfi/core

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - name: Install merry
+        run: curl https://get.merry.dev | bash
+      - name: Start merry
+        run: merry go --headless
+      - name: install dependencies
+        run: |
+          corepack enable
+          yarn set version 4.3.1
+          yarn install
+          yarn run build
+      - run: yarn run test
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - name: install dependencies
+        run: |
+          corepack enable
+          yarn set version 4.3.1
+          yarn install
+      - run: yarn run build

docs/docs/developers/sdk/api-reference/Core.md

@@ -3,25 +3,29 @@ id: core
 ---
 
 # Core
+
 # GardenJS
+
 The `GardenJS` class simplifies the creation of atomic swap orders and interactions with it.
 
 ## Creating a `GardenJS` Instance
+
 ```ts
 constructor(orderbook: IOrderbook, wallets: Partial<Wallets>)
 ```
 
 It accepts an `IOrderbook`, and an object with the keys as the `Chain` and the corresponding wallet for that chain. It can be created as follows:
+
 ```ts
-import { 
-    BitcoinOTA, 
-    EVMWallet,
-    BitcoinNetwork,
-    BitcoinProvider,
-} from "@catalogfi/wallets";
-import { Orderbook, Chains } from "@gardenfi/orderbook";
-import { GardenJS } from "@gardenfi/core";
-import { BrowserProvider } from "ethers";
+import {
+  BitcoinOTA,
+  EVMWallet,
+  BitcoinNetwork,
+  BitcoinProvider,
+} from '@catalogfi/wallets';
+import { Orderbook, Chains } from '@gardenfi/orderbook';
+import { GardenJS } from '@gardenfi/core';
+import { BrowserProvider } from 'ethers';
 
 const bitcoinProvider = new BitcoinProvider(BitcoinNetwork.Testnet);
 const provider = new BrowserProvider(window.ethereum);
@@ -31,19 +35,20 @@ const bitcoinWallet = new BitcoinOTA(bitcoinProvider, signer);
 const ethereumWallet = new EVMWallet(signer);
 
 const orderbook = await Orderbook.init({
-	signer,
-	opts: {
-		domain: window.location.host
-	}
+  signer,
+  opts: {
+    domain: window.location.host,
+  },
 });
 
 const garden = new GardenJS(orderbook, {
-	"ethereum_sepolia": ethereumWallet,
-	"bitcoin_testnet": bitcoinWallet
+  ethereum_sepolia: ethereumWallet,
+  bitcoin_testnet: bitcoinWallet,
 });
 ```
 
 ### Methods
+
 ```ts
 subscribeOrders(address: string, callback: (orders: Orders) => void): void
 
@@ -67,23 +72,28 @@ calculateReceiveAmt(
 ```
 
 ## Subscribe Orders
+
 ```ts
 subscribeOrders(address: string, callback: (orders: Orders) => void): void
 ```
 
 The `subscribeOrders` method is a wrapper over `IOrderbook`'s `subscribeOrders`. This method allows you to listen to all order updates where you're the maker or the taker.
 
 ### Parameters
+
 - `address`: The address whose orders you want to listen to
 - `callback`: a callback function that takes in `Orders` as a parameter.
 
 ## Unsubscribe Orders
+
 ```ts
 unsubscribeOrders(): void
 ```
+
 The `unsubscribeOrders` method stops listening to all orders on all accounts.
 
 ## Swap
+
 ```ts
 swap(
     from: Asset,
@@ -97,37 +107,42 @@ swap(
 The swap method is used to create atomic swap orders. The initiator addresses and receiver addresses are filled based on the wallets provided. For example, if your `fromAsset` is testnet Bitcoin then the address chosen as the initiator address is the testnet Bitcoin wallet.
 
 The secret is the message signed by an `IBitcoinWallet` and the signed message is `garden.js<nonce><EVM wallet's pub key>` where the nonce is the number of orders created plus one (without the angular brackets).
+
 ```ts
 //after creating a GardenJS instance
 
 import { Assets } from '@gardenfi/orderbook';
 
 const orderId = await garden.swap(
-    Assets.bitcoin_testnet.BTC, 
-    Assets.ethereum_sepolia.WBTC, 
-    sendAmount, 
-    receiveAmount
+  Assets.bitcoin_testnet.BTC,
+  Assets.ethereum_sepolia.WBTC,
+  sendAmount,
+  receiveAmount
 );
 ```
 
 ### Parameters
+
 - `from`: The asset that you want to swap from
 - `to`: The asset you want to receive
 - `amt`: The amount that you're sending. Note that this number must be in the lowest denomination of that asset. For example, if you're swapping 1 Bitcoin then the amount must be `100,000,000` SATS
 - `receiveAmount`: The amount of the to Asset that you want to receive. Like the send amount, this amount, too, should be in its lowest denomination.
 - `opts.btcInputAddress`: The address in which you want to receive your Bitcoin.
 
 ### Returns
+
 The order id.
 
 ### Get Swap
+
 ```ts
 getSwap(order: Order): ISwapper
 ```
 
 The `getSwap` method provides a `Swapper` instance that allows you to initiate, redeem, or refund your order by using the `.next()` method. The `.next()` method makes the appropriate action based on the status of the order and the role of the person performing the action that is, initiator or redeemer.
 
 The `status` of an order is 3 digit number where:
+
 - the first digit indicates the overall order status, found in `Order.status`
 - the second digit indicates the order status of the initiator atomic swap, found in `Order.initiatorAtomicSwap.swapStatus`
 - the third digit indicates the order status of the follower (redeemer) atomic swap, found in `Order.followerAtomicSwap.swapStatus`.
@@ -144,16 +159,19 @@ The `parseStatus` function in `@gardenfi/orderbook` provides you the `status` of
 When creating orders, the follower is the backend orderbook fillers.
 
 ### Calculate Receive Amount
+
 ```ts
 calculateReceiveAmt(from: Asset, to: Asset, sendAmt: number): Promise<number>
 ```
 
-Calculates the optimal amount of fee taken by the fillers in the orderbook which is *currently 3%*.
+Calculates the optimal amount of fee taken by the fillers in the orderbook which is _currently 3%_. Note that, this function accepts the `sendAmt` in it's lowest denomination.
 
 ### Parameters
+
 - `from`: The asset that you want to swap from
 - `to`: The asset that you want to swap to
 - `sendAmt`: The amount that you're sending in the lowest denomination of the asset that you're swapping from.
 
 ### Returns
+
 The amount that you will receive in the lowest denomination of the asset that you're swapping.

eslint.config.mjs

@@ -0,0 +1,18 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default [
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    ignores: ['**/dist/*', '**/build/*', 'scripts'],
+  },
+];

package.json

@@ -18,12 +18,18 @@
     "docs"
   ],
   "devDependencies": {
+    "@eslint/js": "^9.6.0",
     "@types/chrome": "^0.0.268",
     "@types/node": "^20.11.30",
+    "eslint": "9.x",
+    "globals": "^15.8.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.2",
+    "typescript-eslint": "^7.15.0",
     "vite": "^5.1.6",
     "vite-plugin-dts": "^3.7.3",
+    "vite-plugin-eslint": "^1.8.1",
     "vitest": "^1.6.0"
-  }
+  },
+  "packageManager": "[email protected]"
 }

packages/core/package.json

@@ -13,6 +13,7 @@
   ],
   "scripts": {
     "build": "vite build",
+    "test": "vitest run",
     "dev": "vite build --watch"
   },
   "main": "./dist/index.cjs",
@@ -31,14 +32,13 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.12",
     "dotenv": "^16.3.1",
-    "jest": "^29.7.0",
     "typescript": "^5.2.2",
     "vite": "^5.1.6",
     "vite-plugin-dts": "^3.7.3",
     "vite-plugin-top-level-await": "^1.4.1",
-    "vite-plugin-wasm": "^3.3.0"
+    "vite-plugin-wasm": "^3.3.0",
+    "vitest": "^1.6.0"
   },
   "sideEffects": false
 }

packages/core/src/lib/errors.ts

@@ -1,4 +1,4 @@
-export const CatalogErrors = {
+export const GardenErrors = {
   WALLET_NOT_FOUND: (from: boolean): string =>
     `${
       from ? 'from' : 'to'