Merge pull request #5 from ubiquibot/development

Merge development into main

.cspell.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "./src/adapters/supabase/**/**.ts"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.http", "**/*.toml", "src/types/database.ts"],
   "useGitignore": true,
   "language": "en",
   "words": ["Nektos", "dataurl", "devpool", "outdir", "servedir", "Supabase", "SUPABASE", "typebox", "ubiquibot", "Smee"],

.dev.vars.example

@@ -1 +1,2 @@
-MY_SECRET="MY_SECRET"
+SUPABASE_URL=
+SUPABASE_KEY=

.github/knip.ts

@@ -3,7 +3,7 @@ import type { KnipConfig } from "knip";
 const config: KnipConfig = {
   entry: ["build/index.ts"],
   project: ["src/**/*.ts"],
-  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
+  ignore: ["**/__mocks__/**", "**/__fixtures__/**", "src/types/database.ts"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
   ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@mswjs/data"],

.github/workflows/compute.yml

@@ -1,4 +1,4 @@
-name: "the name of the plugin"
+name: "command-wallet"
 
 on:
   workflow_dispatch:
@@ -18,7 +18,7 @@ on:
 
 jobs:
   compute:
-    name: "plugin name"
+    name: "command-wallet"
     runs-on: ubuntu-latest
     permissions: write-all
     env:
@@ -38,7 +38,7 @@ jobs:
 
       - name: execute directive
         run: npx tsx ./src/main.ts
-        id: plugin-name
+        id: command-wallet
         env:
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

.github/workflows/conventional-commits.yml

@@ -8,5 +8,5 @@ jobs:
     name: Conventional Commits
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ubiquity/action-conventional-commits@master

.github/workflows/database.yml

@@ -0,0 +1,44 @@
+name: Database
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
+  SUPABASE_DB_PASSWORD: ${{ secrets.SUPABASE_DB_PASSWORD }}
+  SUPABASE_PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}
+
+jobs:
+  generate_types:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Generate Supabase Types
+        run: |
+          yarn install
+          yarn run "supabase:generate:remote"
+
+      - name: Commit and Push generated types
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add src/types/database.ts
+          if [ -n "$(git diff-index --cached --name-only HEAD)" ]; then
+            git commit -m "chore: updated generated Supabase types" || echo "Lint-staged check failed"
+            git push origin main
+          else
+            echo "No changes to commit"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+name: Deploy to Cloudflare Pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy-to-cloudflare:
+    name: Automatic Cloudflare Deploy
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+      - uses: actions/checkout@v4
+      - uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: '3.61.0'
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

.github/workflows/jest-testing.yml

@@ -5,6 +5,8 @@ on:
 
 env:
   NODE_ENV: "test"
+  SUPABASE_URL: "http://127.0.0.1:3000"
+  SUPABASE_KEY: "supabase-key"
 
 jobs:
   testing:

.github/workflows/knip-reporter.yml

@@ -11,6 +11,7 @@ permissions: write-all
 jobs:
   knip-reporter:
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion != 'success' }}
     steps:
       - uses: actions/download-artifact@v4
         with:
@@ -26,7 +27,6 @@ jobs:
           trim: true
 
       - name: Report knip results to pull request
-        if: ${{ github.event.workflow_run.conclusion != 'success' }}
         uses: gitcoindev/knip-reporter@main
         with:
           verbose: true

.gitignore

@@ -14,4 +14,6 @@ coverage
 junit.xml
 cypress/screenshots
 script.ts
-.wrangler
+.wrangler
+http-client.private.env.json
+test-dashboard.md

README.md

@@ -1,4 +1,6 @@
-# `@ubiquibot/plugin-template`
+# `@ubiquibot/command-wallet`
+
+Allows users to register their wallets to collect rewards.
 
 ## Prerequisites
 
@@ -7,38 +9,23 @@
 
 ## Getting Started
 
-1. Create a new repository using this template.
-2. Clone the repository to your local machine.
-3. Install the dependencies preferably using `yarn` or `bun`.
-
-## Creating a new plugin
-
-- If your plugin is to be used as a slash command which should have faster response times as opposed to longer running GitHub action tasks, you should use the `worker` type.
-
-1. Ensure you understand and have setup the [kernel](https://github.com/ubiquity/ubiquibot-kernel).
-2. Update [compute.yml](./.github/workflows/compute.yml) with your plugin's name and update the `id`.
-3. Update [context.ts](./src/types/context.ts) with the events that your plugin will fire on.
-4. Update [plugin-inputs.ts](./src/types/plugin-inputs.ts) to match the `with:` settings in your org or repo level configuration.
+1. Install the dependencies preferably using `yarn` or `bun`.
+2. Copy `.dev.vars.example` to `.dev.vars` and fill the variables
+3. Generate Supabase types by running
+    ```shell
+    yarn prebuild
+    ```
+4. Run the project with `yarn wrangler`
 
-- Your plugin config should look similar to this:
+## Example configuration
 
 ```yml
-- plugin: <plugin-org/owner>/<plugin-repo-name>:compute.yml@development
-  name: plugin-name
-  id: plugin-name-command
-  description: "Plugin description" # small description of what the plugin does
-  command: "<regex for command>" # if you are creating a plugin with a slash command
-  example: "<example usage>" # how to invoke the slash command
-  with: # these are the example settings, the kernel passes these to the plugin.
-    disabledCommands: []
-    timers:
-      reviewDelayTolerance: 86000
-      taskStaleTimeoutDuration: 2580000
-    miscellaneous:
-      maxConcurrentTasks: 3
-    labels:
-      time: []
-      priority: []
+- plugin: ubiquibot/command-wallet
+  name: command-wallet
+  id: command-wallet
+  description: "Allows users to register their wallets to collect rewards."
+  command: "/wallet"
+  example: "/wallet ubiquibot.eth"
 ```
 
 ###### At this stage, your plugin will fire on your defined events with the required settings passed in from the kernel. You can now start writing your plugin's logic.

eslint.config.mjs

@@ -9,7 +9,7 @@ export default tsEslint.config({
     "@typescript-eslint": tsEslint.plugin,
     "check-file": checkFile,
   },
-  ignores: [".github/knip.ts"],
+  ignores: [".github/knip.ts", "src/types/database.ts"],
   extends: [eslint.configs.recommended, ...tsEslint.configs.recommended, sonarjs.configs.recommended],
   languageOptions: {
     parser: tsEslint.parser,

jest.config.json

@@ -6,5 +6,6 @@
   "collectCoverage": true,
   "coverageReporters": ["json", "lcov", "text", "clover", "json-summary"],
   "reporters": ["default", "jest-junit", "jest-md-dashboard"],
-  "coverageDirectory": "coverage"
+  "coverageDirectory": "coverage",
+  "setupFiles": ["dotenv/config"]
 }

package.json

@@ -1,23 +1,26 @@
 {
-  "name": "plugin-template",
+  "name": "command-wallet",
   "version": "1.0.0",
-  "description": "Ubiquibot plugin template repository with TypeScript support.",
+  "description": "Allows users to register their wallets to collect rewards.",
   "author": "Ubiquity DAO",
   "license": "MIT",
   "main": "src/worker.ts",
   "engines": {
     "node": ">=20.10.0"
   },
   "scripts": {
+    "prebuild": "dotenv -- cross-env yarn supabase:generate:remote",
     "format": "run-p format:*",
     "format:lint": "eslint --fix .",
     "format:prettier": "prettier --write .",
     "format:cspell": "cspell **/*",
     "knip": "knip --config .github/knip.ts",
     "knip-ci": "knip --no-exit-code --reporter json --config .github/knip.ts",
     "prepare": "husky install",
-    "test": "jest --setupFiles dotenv/config --coverage",
-    "worker": "wrangler dev --env dev --port 4000"
+    "test": "DOTENV_CONFIG_PATH=.dev.vars jest --setupFiles dotenv/config --coverage",
+    "worker": "wrangler dev --env dev --port 4000",
+    "supabase:generate:local": "supabase gen types typescript --local > src/types/database.ts",
+    "supabase:generate:remote": "cross-env-shell \"supabase gen types typescript --project-id $SUPABASE_PROJECT_ID --schema public > src/types/database.ts\""
   },
   "keywords": [
     "typescript",
@@ -33,7 +36,9 @@
     "@octokit/webhooks": "13.2.7",
     "@sinclair/typebox": "0.32.33",
     "@supabase/supabase-js": "2.43.5",
+    "commander": "12.1.0",
     "dotenv": "16.4.5",
+    "ethers": "6.13.1",
     "typebox-validators": "0.3.5"
   },
   "devDependencies": {
@@ -46,7 +51,9 @@
     "@jest/globals": "29.7.0",
     "@mswjs/data": "0.16.1",
     "@types/node": "20.14.5",
+    "cross-env": "7.0.3",
     "cspell": "8.9.0",
+    "dotenv-cli": "7.4.2",
     "eslint": "9.5.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-check-file": "2.8.0",
@@ -60,11 +67,12 @@
     "lint-staged": "15.2.7",
     "npm-run-all": "4.1.5",
     "prettier": "3.3.2",
+    "supabase": "1.178.2",
     "ts-jest": "29.1.5",
     "tsx": "4.15.6",
     "typescript": "5.4.5",
     "typescript-eslint": "7.13.1",
-    "wrangler": "3.60.3"
+    "wrangler": "3.61.0"
   },
   "lint-staged": {
     "*.ts": [

src/adapters/index.ts

@@ -1,17 +1,11 @@
 import { SupabaseClient } from "@supabase/supabase-js";
-import { Context } from "../types/context";
-import { Access } from "./supabase/helpers/access";
-import { User } from "./supabase/helpers/user";
-import { Label } from "./supabase/helpers/label";
-import { Super } from "./supabase/helpers/supabase";
+import { Context } from "../types";
+import { Wallet } from "./supabase/helpers/wallet";
 
 export function createAdapters(supabaseClient: SupabaseClient, context: Context) {
   return {
     supabase: {
-      access: new Access(supabaseClient, context),
-      user: new User(supabaseClient, context),
-      label: new Label(supabaseClient, context),
-      super: new Super(supabaseClient, context),
+      wallet: new Wallet(supabaseClient, context),
     },
   };
 }