Merge pull request #25 from ubiquity-os-marketplace/development

Merge development into main

.cspell.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.http", "**/*.toml", "src/types/database.ts"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.http", "**/*.toml", "src/types/database.ts", "dist/**"],
   "useGitignore": true,
   "language": "en",
-  "words": ["Nektos", "dataurl", "devpool", "outdir", "servedir", "Supabase", "SUPABASE", "typebox", "ubiquibot", "Smee"],
+  "words": ["Nektos", "dataurl", "devpool", "outdir", "servedir", "Supabase", "SUPABASE", "typebox", "ubiquibot", "Smee", "Rpcs", "hono"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"]

.github/knip.ts

@@ -1,12 +1,12 @@
 import type { KnipConfig } from "knip";
 
 const config: KnipConfig = {
-  entry: ["build/index.ts"],
+  entry: ["src/main.ts", "src/worker.ts"],
   project: ["src/**/*.ts"],
   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"],
+  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@mswjs/data", "ts-node", "hono"],
   eslint: true,
 };
 

.github/workflows/compute.yml

@@ -1,4 +1,4 @@
-name: "command-wallet"
+name: "Plugin Compute"
 
 on:
   workflow_dispatch:
@@ -15,15 +15,17 @@ on:
         description: "Auth Token"
       ref:
         description: "Ref"
+      signature:
+        description: "Signature tp identify the Kernel"
+      command:
+        description: "Command"
 
 jobs:
   compute:
     name: "command-wallet"
     runs-on: ubuntu-latest
     permissions: write-all
-    env:
-      SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
-      SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+    environment: ${{ github.ref == 'refs/heads/main' && 'main' || 'development' }}
 
     steps:
       - uses: actions/checkout@v4
@@ -33,12 +35,10 @@ jobs:
         with:
           node-version: "20.10.0"
 
-      - name: install dependencies
-        run: yarn
-
       - name: execute directive
-        run: npx tsx ./src/main.ts
-        id: command-wallet
+        run: node dist/index.js
         env:
+          PLUGIN_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KERNEL_PUBLIC_KEY: ${{ secrets.KERNEL_PUBLIC_KEY }}
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

.github/workflows/database.yml

@@ -24,10 +24,13 @@ jobs:
         with:
           node-version: "20.10.0"
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
       - name: Generate Supabase Types
         run: |
-          yarn install
-          yarn run "supabase:generate:remote"
+          bun install --frozen-lockfile
+          bun run "supabase:generate:remote"
 
       - name: Commit and Push generated types
         run: |

.github/workflows/formatting-checks.yml

@@ -0,0 +1,28 @@
+name: Formatting Check
+
+on:
+  push:
+
+jobs:
+  format-check:
+    name: Check for formatting errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install toolchain
+        run: bun install --frozen-lockfile
+
+      - name: Eslint
+        run: bun run eslint --fix-dry-run
+
+      - name: Cspell
+        run: bun run format:cspell
+
+      - name: Prettier
+        run: bun run prettier --check .

.github/workflows/jest-testing.yml

@@ -21,8 +21,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install toolchain
+        run: bun install --frozen-lockfile
+
       - name: Jest With Coverage
-        run: yarn install --immutable --immutable-cache --check-cache && yarn test
+        run: bun run test
 
       - name: Add Jest Report to Summary
         if: always()

.github/workflows/knip.yml

@@ -16,14 +16,17 @@ jobs:
         with:
           node-version: 20.10.0
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
       - name: Install toolchain
-        run: yarn install
+        run: bun install --frozen-lockfile
 
       - name: Store PR number
         run: echo ${{ github.event.number }} > pr-number.txt
 
       - name: Run Knip
-        run: yarn knip || yarn knip --reporter json > knip-results.json
+        run: bun run knip || bun run knip --reporter json > knip-results.json
 
       - name: Upload knip result
         if: failure()

.github/workflows/update-configuration.yml

@@ -0,0 +1,21 @@
+name: Update Manifest and Commit Changes
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  update-manifest:
+    name: "Update Manifest and Commit Changes"
+    runs-on: ubuntu-latest
+    permissions: write-all
+
+    steps:
+      - name: Update Manifest and Commit Changes
+        uses: ubiquity-os/action-deploy-plugin@main
+        with:
+          treatAsEsm: false
+          sourcemap: false
+          pluginEntry: ${{ github.workspace }}/src/main.ts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/worker-delete.yml

@@ -0,0 +1,44 @@
+name: Delete Deployment
+
+on:
+  delete:
+
+jobs:
+  delete:
+    runs-on: ubuntu-latest
+    name: Delete Deployment
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Enable corepack
+        run: corepack enable
+
+      - uses: actions/checkout@v4
+
+      - name: Get Deleted Branch Name
+        id: get_branch
+        run: |
+          branch_name=$(echo '${{ github.event.ref }}' | sed 's#refs/heads/##' | sed 's#[^a-zA-Z0-9]#-#g')
+          echo "branch_name=$branch_name" >> $GITHUB_ENV
+      - name: Retrieve and Construct Full Worker Name
+        id: construct_worker_name
+        run: |
+          base_name=$(grep '^name = ' wrangler.toml | sed 's/^name = "\(.*\)"$/\1/')
+          full_worker_name="${base_name}-${{ env.branch_name }}"
+          # Make sure that it doesnt exceed 63 characters or it will break RFC 1035
+          full_worker_name=$(echo "${full_worker_name}" | cut -c 1-63)
+          echo "full_worker_name=$full_worker_name" >> $GITHUB_ENV
+      - name: Delete Deployment with Wrangler
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: delete --name ${{ env.full_worker_name }}
+
+      - name: Output Deletion Result
+        run: |
+          echo "### Deployment URL" >> $GITHUB_STEP_SUMMARY
+          echo 'Deployment `${{ env.full_worker_name }}` has been deleted.' >> $GITHUB_STEP_SUMMARY

.github/workflows/worker-deploy.yml

@@ -0,0 +1,63 @@
+name: Deploy Worker
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  deploy-to-cloudflare:
+    runs-on: ubuntu-latest
+    name: Automatic Cloudflare Deploy
+    environment: ${{ github.ref == 'refs/heads/main' && 'main' || 'development' }}
+
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Enable corepack
+        run: corepack enable
+
+      - uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Update wrangler.toml Name Field
+        run: |
+          branch_name=$(echo '${{ github.event.ref }}' | sed 's#refs/heads/##' | sed 's#[^a-zA-Z0-9]#-#g')
+          # Extract base name from wrangler.toml
+          base_name=$(grep '^name = ' wrangler.toml | sed 's/^name = "\(.*\)"$/\1/')
+          # Concatenate branch name with base name
+          new_name="${base_name}-${branch_name}"
+          # Truncate the new name to 63 characters for RFC 1035
+          new_name=$(echo "$new_name" | cut -c 1-63)
+          # Update the wrangler.toml file
+          sed -i "s/^name = .*/name = \"$new_name\"/" wrangler.toml
+          echo "Updated wrangler.toml name to: $new_name"
+
+      - name: Deploy with Wrangler
+        id: wrangler_deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: "3.87.0"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+            CLOUDFLARE_ACCOUNT_ID
+            CLOUDFLARE_API_TOKEN
+            ${{ secrets.KERNEL_PUBLIC_KEY && secrets.KERNEL_PUBLIC_KEY != '' && 'KERNEL_PUBLIC_KEY' || '' }}
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          KERNEL_PUBLIC_KEY: ${{ secrets.KERNEL_PUBLIC_KEY }}
+
+      - name: Write Deployment URL to Summary
+        run: |
+          echo "### Deployment URL" >> $GITHUB_STEP_SUMMARY
+          echo "${{ steps.wrangler_deploy.outputs.deployment-url }}" >> $GITHUB_STEP_SUMMARY

.prettierignore

@@ -0,0 +1,2 @@
+dist/
+coverage/

CHANGELOG.md

@@ -1,14 +1,23 @@
 # Changelog
 
-## 1.0.0 (2024-07-08)
-
+## [1.1.0](https://github.com/Meniole/command-wallet/compare/v1.0.0...v1.1.0) (2024-07-16)
 
 ### Features
 
-* added test for wallet link ([e059e13](https://github.com/ubiquibot/command-wallet/commit/e059e1329da781194a4f7a928be17015d2b28962))
-* parsing arguments and executing run ([70fb75e](https://github.com/ubiquibot/command-wallet/commit/70fb75e6e970d6439f5d9ba64ee51caa5edaf269))
+- added test for wallet link ([e059e13](https://github.com/Meniole/command-wallet/commit/e059e1329da781194a4f7a928be17015d2b28962))
+- parsing arguments and executing run ([70fb75e](https://github.com/Meniole/command-wallet/commit/70fb75e6e970d6439f5d9ba64ee51caa5edaf269))
+
+### Bug Fixes
+
+- fixed crash when user does not exist ([433a6a7](https://github.com/Meniole/command-wallet/commit/433a6a7c3f19b2722df75e7b826bc6b8e0244a1e))
+
+## 1.0.0 (2024-07-08)
+
+### Features
 
+- added test for wallet link ([e059e13](https://github.com/ubiquibot/command-wallet/commit/e059e1329da781194a4f7a928be17015d2b28962))
+- parsing arguments and executing run ([70fb75e](https://github.com/ubiquibot/command-wallet/commit/70fb75e6e970d6439f5d9ba64ee51caa5edaf269))
 
 ### Bug Fixes
 
-* fixed crash when user does not exist ([433a6a7](https://github.com/ubiquibot/command-wallet/commit/433a6a7c3f19b2722df75e7b826bc6b8e0244a1e))
+- fixed crash when user does not exist ([433a6a7](https://github.com/ubiquibot/command-wallet/commit/433a6a7c3f19b2722df75e7b826bc6b8e0244a1e))

README.md

@@ -12,20 +12,18 @@ Allows users to register their wallets to collect rewards.
 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
-    ```
+   ```shell
+   yarn prebuild
+   ```
 4. Run the project with `yarn wrangler`
 
 ## Example configuration
 
 ```yml
-- plugin: ubiquibot/command-wallet
-  name: command-wallet
+- plugin: https://ubiquibot-command-wallet.ubiquity.workers.dev
   id: command-wallet
-  description: "Allows users to register their wallets to collect rewards."
-  command: "/wallet"
-  example: "/wallet ubiquibot.eth"
+  with:
+    registerWalletWithVerification: false
 ```
 
 ###### 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.