TypeScript Package

.cursor/rules/suggest-lodash.mdc

@@ -0,0 +1,6 @@
+---
+description:
+globs: *.ts
+alwaysApply: false
+---
+When you suggest code changes that need to use utility functions such as Object.values, Object.entries, etc., please default to using lodash (_) instead of the Object. syntax. Do this unless I tell you otherwise.

.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.env.example

@@ -0,0 +1 @@
+VITE_ETHERSCAN_API_KEY="YOUR_ETHERSCAN_API_KEY"

.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: "CI"
 
+concurrency:
+  cancel-in-progress: true
+  group: ${{github.workflow}}-${{github.ref}}
+
 on:
   pull_request:
   push:
@@ -14,14 +18,21 @@ jobs:
 
       - name: "Install Bun"
         uses: "oven-sh/setup-bun@v2"
+        with:
+          bun-version: "latest"
 
       - name: "Install the Node.js dependencies"
-        run: "bun install"
+        run: "bun install --frozen-lockfile"
+
+      - name: "Check the code"
+        run: "bun run check"
 
-      - name: "Lint the code"
-        run: "bun run prettier:check"
+      - name: "Run the tests"
+        env:
+          VITE_ETHERSCAN_API_KEY: ${{ secrets.VITE_ETHERSCAN_API_KEY }}
+        run: "bun run test"
 
       - name: "Add summary"
-        run: |
+        run: | # shell
           echo "## CI result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.github/workflows/cron-tests.yml

@@ -0,0 +1,36 @@
+name: "Cron: Tests"
+
+on:
+  schedule:
+    # Runs at 02:00 UTC every day
+    - cron: "0 2 * * *"
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v2"
+        with:
+          bun-version: "latest"
+
+      - name: "Install the Node.js dependencies"
+        run: "bun install --frozen-lockfile"
+
+      - name: "Check the code"
+        run: "bun run check"
+
+      - name: "Run the tests"
+        env:
+          TEST_ONLY_CHAINS: true
+          TEST_ONLY_CONTRACTS: true
+        run: "bun run test"
+
+      - name: "Add summary"
+        run: | # shell
+          echo "## Cron Tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -1,5 +1,7 @@
 # directories
-node_modules
+/dist/
+/logs/
+/node_modules/
 
 # files
 *.env

.lintstagedrc.yml

@@ -1 +1,2 @@
-"*.{json,md,yml}": "bun run prettier:write"
+"*.{json,jsonc,ts}": "bun run biome:write"
+"*.{md,yml}": "bun run prettier:write"

.prettierignore

@@ -0,0 +1 @@
+**/*.ts

.prettierrc.js

@@ -0,0 +1,3 @@
+const sharedConfig = require("@sablier/configs/prettier");
+
+module.exports = sharedConfig;

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["biomejs.biome", "esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "biome.enabled": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.biome": "explicit",
+    "source.organizeImports.biome": "explicit"
+  },
+  "[javascript][json][jsonc][typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[md][yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

README.md

@@ -64,6 +64,26 @@ to have different addresses on each chain. By using CREATE2, we can systematical
 by passing a salt, whereas if we had used CREATE, the deployer's nonce would have impacted the resulting deployment
 address.
 
+## Logging
+
+This project uses Winston for logging. By default, logs are output to the console, but they can also be written to a
+file by setting the following environment variables:
+
+- `LOG_FILE_PATH`: Path to the log file (e.g., `./logs/deployments.log`). When set, logs will be written to this file in
+  addition to the console.
+- `LOG_LEVEL`: Set the logging level (default: `info`). Valid values are: `error`, `warn`, `info`, `verbose`, `debug`,
+  and `silly`.
+
+Example usage:
+
+```bash
+# Log to both console and file
+LOG_FILE_PATH=./logs/deployments.log bun run build
+
+# Set a custom log level
+LOG_LEVEL=debug LOG_FILE_PATH=./logs/debug.log bun run test
+```
+
 ## License
 
 This repo is licensed under GPL 3-0 or later.

biome.jsonc

@@ -0,0 +1,19 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["@sablier/configs/biome"],
+  "files": {
+    "includes": ["**/*.js", "**/*.json", "**/*.jsonc", "**/*.ts"]
+  },
+  "overrides": [
+    {
+      "includes": ["**/tests/*"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noFocusedTests": "off"
+          }
+        }
+      }
+    }
+  ]
+}