TypeScript Package

.cursor/rules/use-lodash.mdc

@@ -0,0 +1,6 @@
+---
+description:
+globs: *.ts
+alwaysApply: false
+---
+When you suggest code snippets that contain utility functions such as `Object.values`, `Object.entries`, etc., use lodash (_) instead of the `Object.` syntax. Do so 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:
@@ -12,16 +16,26 @@ jobs:
       - name: "Check out the repo"
         uses: "actions/checkout@v4"
 
+      - name: "Set up devkit"
+        uses: "sablier-labs/devkit/actions/setup@main"
+
       - 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: "just full-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: "just 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,41 @@
+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: "Install Just"
+        uses: "extractions/setup-just@v3"
+        with:
+          just-version: "1"
+
+      - name: "Check the code"
+        run: "just full-check"
+
+      - name: "Run the tests"
+        env:
+          TEST_ONLY_CHAINS: true
+          TEST_ONLY_CONTRACTS: true
+        run: "just test"
+
+      - name: "Add summary"
+        run: | # shell
+          echo "## Cron Tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -1,11 +1,13 @@
 # directories
+dist
+logs
 node_modules
+repomix
 
 # files
 *.env
 *.log
-.DS_Store
-.pnp.*
+*.tsbuildinfo
 bun.lockb
 lcov.info
 package-lock.json

.lintstagedrc.js

@@ -0,0 +1,8 @@
+/**
+ * @type {import("lint-staged").Configuration}
+ */
+module.exports = {
+  "*.{json,jsonc,ts}": "bun biome check --write",
+  "*.{md,yml}": "bun prettier --cache --write",
+  "*.ts": "bun biome lint --write --only correctness/noUnusedImports",
+};

.prettierignore

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

.prettierrc.js

@@ -0,0 +1,9 @@
+const baseConfig = require("@sablier/devkit/prettier");
+
+/**
+ * @see https://prettier.io/docs/configuration
+ * @type {import("prettier").Config}
+ */
+const config = baseConfig;
+
+module.exports = config;

.vscode/extensions.json

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

.vscode/settings.json

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

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+## Contributing
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org) (v20+)
+- [Just](https://github.com/casey/just) (command runner)
+- [Bun](https://bun.sh) (package manager)
+
+### Setup
+
+```bash
+git clone https://github.com/sablier-labs/deployments.git
+cd deployments
+just install
+```
+
+### Available Commands
+
+```bash
+just --list                 # Show all available commands
+just build                  # Build the TypeScript package
+just full-check             # Run all code quality checks
+just full-write             # Auto-fix formatting and linting
+just test                   # Run test suite
+```
+
+### Development Workflow
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run `just full-check` to verify code quality
+5. Submit a pull request
+
+### Adding New Chains
+
+TODO
+
+### Adding New Deployments
+
+TODO