chore: add testing framework

Author: joepegler

.env.example

@@ -1 +1,2 @@
-TEST_PRIVATE_KEY=
+TEST_PRIVATE_KEY=
+RUN_PAID_TESTS=false

.github/workflows/funded-tests.yml

@@ -0,0 +1,29 @@
+name: funded-tests
+on:
+  workflow_dispatch:
+  pull_request_review:
+    types: [submitted]
+jobs:
+  funded-tests:
+    name: funded-tests
+    permissions: write-all
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-funded-tests
+      cancel-in-progress: true
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Run the tests
+        run: bun run test
+        env:
+          TEST_PRIVATE_KEY: ${{ secrets.TEST_PRIVATE_KEY }}
+          RUN_PAID_TESTS: true
+          CI: true 

README.md

@@ -21,6 +21,7 @@ Then in your linked project, update your package.json dependencies to point to t
     "@biconomy/abstractjs": "file:../../abstractjs"
   }
 }
+```
 
 This will run the package in watch mode, and will automatically update the package in your linked project.
 
@@ -39,7 +40,7 @@ Currently the only tests which this project has interact with testnets, due to s
 - For tests to work, an `.env` file needs to contain the `TEST_PRIVATE_KEY` variable!
 
 ```sh
-bun i --frozen-lockfile && bun test
+bun i --frozen-lockfile && bun run test
 ```
 
 

bun.lockb

@@ -21,6 +21,7 @@
   },
   "files": ["dist"],
   "scripts": {
+    "test": "vitest -c ./tests/vitest.config.ts",
     "dev": "bun link && bun run build:types && bun run build:watch",
     "changeset": "changeset",
     "changeset:release": "bun run build && changeset publish",
@@ -44,10 +45,16 @@
     "@size-limit/esbuild-why": "^11.1.6",
     "@size-limit/preset-small-lib": "^11.1.6",
     "@types/bun": "latest",
+    "@vitest/coverage-istanbul": "^2.1.8",
+    "dotenv": "^16.4.7",
+    "get-port": "^7.1.0",
     "gh-pages": "^6.3.0",
+    "prool": "^0.0.16",
     "semver": "^7.6.3",
     "size-limit": "^11.1.6",
-    "tsup": "^8.3.5"
+    "tsup": "^8.3.5",
+    "viem-deal": "^2.0.4",
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "typescript": "^5.0.0",

package.json

@@ -0,0 +1,68 @@
+import { beforeAll, describe, expect, inject, test } from "vitest"
+import {
+  type Chain,
+  zeroAddress,
+  type LocalAccount,
+  isHex,
+  isAddress,
+  http
+} from "viem"
+import { base, baseSepolia, optimism, optimismSepolia } from "viem/chains"
+import { privateKeyToAccount, generatePrivateKey } from "viem/accounts"
+import { mcUSDC } from "../commons/tokens/stablecoins"
+import type { MultichainSmartAccount } from "./account"
+import { toMultichainNexusAccount } from "./nexus/multichain-nexus.account"
+import { toMeeCompliantNexusAccount } from "./nexus/nexus-mee-compliant"
+
+describe("accounts", async () => {
+  let eoa: LocalAccount
+  let mcNexusTestnet: MultichainSmartAccount
+  let mcNexusMainnet: MultichainSmartAccount
+
+  beforeAll(async () => {
+    eoa = privateKeyToAccount(generatePrivateKey())
+
+    mcNexusTestnet = await toMultichainNexusAccount({
+      chains: [baseSepolia, optimismSepolia],
+      signer: eoa
+    })
+
+    mcNexusMainnet = await toMultichainNexusAccount({
+      chains: [base, optimism],
+      signer: eoa
+    })
+  })
+
+  test("should have configured accounts correctly", async () => {
+    expect(mcNexusMainnet.deployments.length).toEqual(2)
+    expect(mcNexusTestnet.deployments.length).toEqual(2)
+    expect(mcNexusTestnet.deploymentOn(baseSepolia.id).address).toEqual(
+      mcNexusTestnet.deploymentOn(optimismSepolia.id).address
+    )
+  })
+
+  test("should sign message using MEE Compliant Nexus Account", async () => {
+    const nexus = await toMeeCompliantNexusAccount({
+      chain: optimism,
+      signer: eoa,
+      transport: http()
+    })
+
+    expect(isAddress(nexus.address)).toBeTruthy()
+
+    const signed = await nexus.signMessage({ message: { raw: "0xABC" } })
+    expect(isHex(signed)).toBeTruthy()
+  })
+
+  test("should read usdc balance on mainnet", async () => {
+    const readAddress = mcNexusMainnet.deploymentOn(optimism.id).address
+    const usdcBalanceOnChains = await mcUSDC.read({
+      account: mcNexusMainnet,
+      functionName: "balanceOf",
+      args: [readAddress],
+      onChains: [base, optimism]
+    })
+
+    expect(usdcBalanceOnChains.length).toEqual(2)
+  })
+})

src/account-vendors/account.test.ts

@@ -1,12 +1,11 @@
 import type { Signer } from "@biconomy/sdk"
-import { http, type Chain, type Transport } from "viem"
-import type { NonEmptyArray } from "../../utils/types/util.type"
+import { http, type Chain } from "viem"
 import { MultichainSmartAccount } from "../account"
 import { toMeeCompliantNexusAccount } from "./nexus-mee-compliant"
 
 export type MeeNexusParams = {
   signer: Signer
-  chains: NonEmptyArray<Chain>
+  chains: Chain[]
 }
 
 export async function toMultichainNexusAccount(

src/account-vendors/nexus/multichain-nexus.account.ts

@@ -1,17 +1,23 @@
 import { erc20Abi } from "viem"
-import { arbitrum, avalanche, base, optimism, polygon } from "viem/chains"
-import { address } from "../../primitives"
 import {
-  MultichainContract,
-  getMultichainContract
-} from "../../utils/contract/getMultichainContract"
+  anvil,
+  arbitrum,
+  avalanche,
+  base,
+  baseSepolia,
+  optimism,
+  polygon
+} from "viem/chains"
+import { getMultichainContract } from "../../utils/contract/getMultichainContract"
 
 export const mcUSDC = getMultichainContract<typeof erc20Abi>({
   abi: erc20Abi,
   deployments: [
     ["0xaf88d065e77c8cC2239327C5EDb3A432268e5831", arbitrum.id],
     ["0x0b2c639c533813f4aa9d7837caf62653d097ff85", optimism.id],
     ["0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", base.id],
+    ["0x036CbD53842c5426634e7929541eC2318f3dCF7e", baseSepolia.id],
+    ["0x036CbD53842c5426634e7929541eC2318f3dCF7e", anvil.id],
     ["0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E", avalanche.id],
     ["0x3c499c542cef5e3811e1192ce70d8cc03d5c3359", polygon.id]
   ]

src/commons/tokens/stablecoins.ts

@@ -0,0 +1,76 @@
+import { type LocalAccount, type Chain, zeroAddress, isHex } from "viem"
+import { base } from "viem/chains"
+import { inject, describe, beforeAll, test, expect } from "vitest"
+import { initNetwork } from "../tests/config"
+import {
+  type MultichainSmartAccount,
+  toMultichainNexusAccount
+} from "./account-vendors"
+import { createMeeService } from "./mee.service"
+import {
+  supertransaction,
+  type SupportedFeeChainId,
+  signMeeQuote
+} from "./utils"
+import { getExplorerTxLink } from "./utils/explorer/explorer"
+import { buildMeeUserOp } from "./workflow"
+
+const runPaidTests = inject("runPaidTests")
+describe.runIf(runPaidTests)("meeService", async (args) => {
+  let eoa: LocalAccount
+  let paymentChain: Chain
+  let mcNexusMainnet: MultichainSmartAccount
+
+  const meeService = createMeeService()
+
+  beforeAll(async () => {
+    const network = await initNetwork("NETWORK_FROM_ENV")
+    eoa = network.eoa
+    paymentChain = network.paymentChain
+
+    mcNexusMainnet = await toMultichainNexusAccount({
+      chains: [base, paymentChain],
+      signer: eoa
+    })
+  })
+
+  test("should get a quote", async () => {
+    const mcNexusMainnet = await toMultichainNexusAccount({
+      chains: [base, paymentChain],
+      signer: eoa
+    })
+
+    const quote = await supertransaction()
+      .injectAccount(mcNexusMainnet)
+      .payGasWith("USDC", { on: paymentChain.id as SupportedFeeChainId })
+      .addInstructions(
+        buildMeeUserOp({
+          calls: {
+            to: zeroAddress,
+            gasLimit: 50_000n,
+            value: 0n
+          },
+          chainId: base.id
+        })
+      )
+      .getQuote(meeService)
+
+    expect(quote.hash.startsWith("0x")).toBeTruthy()
+
+    const receipt = await meeService.execute(
+      await signMeeQuote({
+        executionMode: "direct-to-mee",
+        quote: quote,
+        signer: eoa
+      })
+    )
+
+    expect(isHex(receipt.hash)).toBeTruthy()
+    const explorerUrl = getExplorerTxLink(receipt.hash)
+
+    expect(explorerUrl).toEqual(
+      `https://meescan.biconomy.io/details/${receipt.hash}`
+    )
+    console.log(`Supertransaction: ${explorerUrl}`)
+  })
+})

src/mee.service.test.ts

@@ -243,13 +243,8 @@ export function formatMeeSignature(parameters: {
 export function createMeeService(params?: MeeServiceInitParams) {
   console.warn(`
     --------------------------- READ ----------------------------------------------
-    You are using the Developer Preview of the Biconomy MEE! The SDK has not been
-    thoroughly tested and the underlying contracts are still in the auditing process.
-    The interface, package name and developer flow might change significantly from now
-    until the release data.
-    
-    This Developer preview is meant only as a demonstrator of the capabilities 
-    for the MEE stack. Do not use in commercial projects!
+    You are using the Developer Preview of the Biconomy MEE. The underlying 
+    contracts are still being audited.
     -------------------------------------------------------------------------------
   `)
   return new MeeService(params)