feat: permits are generated from the calculation results and redirect to the permit claim page

.github/workflows/jest-testing.yml

@@ -12,6 +12,9 @@ jobs:
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+      SUPABASE_ANON_KEY: ${{ secrets.SUPABASE_ANON_KEY }}
+      X25519_PRIVATE_KEY: ${{ secrets.X25519_PRIVATE_KEY }}
 
     steps:
       - name: Checkout code

.github/workflows/main.yml

@@ -0,0 +1,40 @@
+name: Run Local Tests
+
+on:
+  workflow_dispatch:
+    inputs:
+      issueUrl:
+        description: "The URL the the issue needing to be parsed"
+        required: true
+      evmNetworkId:
+        description: "The EVM network ID to use"
+        required: true
+        type: number
+      evmPrivateEncrypted:
+        description: "The encrypted EVM private key"
+        required: true
+
+jobs:
+  test-local:
+    name: Run Local Tests
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+      SUPABASE_ANON_KEY: ${{ secrets.SUPABASE_ANON_KEY }}
+      X25519_PRIVATE_KEY: ${{ secrets.X25519_PRIVATE_KEY }}
+
+    steps:
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Action Test
+        # Replace with whatever package version you want to test
+        uses: gentlementlegen/conversation-rewards@feat/permit-generation
+        with:
+          issueUrl: ${{ inputs.issueUrl }}
+          evmNetworkId: ${{ inputs.evmNetworkId }}
+          evmPrivateEncrypted: ${{ inputs.evmPrivateEncrypted }}

.github/workflows/release-please.yml

@@ -0,0 +1,16 @@
+name: Release Please
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          release-type: simple
+          default-branch: main

action.yml

@@ -1,9 +1,15 @@
 name: "Conversation Rewards"
 description: "Compute rewards for contributors' discussion on issues that are closed as complete."
 inputs:
-  issue_url:
+  issueUrl:
     description: "The URL the the issue needing to be parsed"
     required: true
+  evmNetworkId:
+    description: "The EVM network ID to use"
+    required: true
+  evmPrivateEncrypted:
+    description: "The encrypted EVM private key"
+    required: true
 outputs:
   result:
     description: "The result containing all the rewards of the users"
@@ -13,7 +19,7 @@ runs:
   steps:
     - run: |
         yarn --cwd ${{ github.action_path }} --production=true
-        yarn --cwd ${{ github.action_path }} start --issue "${{ inputs.issue_url }}" --file "${{ github.action_path }}/results.json"
+        yarn --cwd ${{ github.action_path }} start --issue "${{ inputs.issueUrl }}" --evmNetworkId "${{ inputs.evmNetworkId }}" --evmPrivateEncrypted "${{ inputs.evmPrivateEncrypted }}" --file "${{ github.action_path }}/results.json"
         output=$(cat ${{ github.action_path }}/results.json | tr -s ' ' | tr -d '\n')
         echo "Output of calculations:"
         echo "$output"

package.json

@@ -26,9 +26,12 @@
     "open-source"
   ],
   "dependencies": {
+    "@actions/github": "6.0.0",
     "@commander-js/extra-typings": "12.0.1",
-    "@octokit/rest": "20.0.2",
+    "@octokit/rest": "20.1.0",
     "@sinclair/typebox": "0.32.20",
+    "@supabase/supabase-js": "2.42.0",
+    "@ubiquibot/permit-generation": "1.0.2",
     "commander": "12.0.0",
     "decimal.js": "10.4.3",
     "dotenv": "16.4.5",

rewards-configuration.default.yml

@@ -51,3 +51,5 @@ formattingEvaluator:
     - type: [REVIEW, CONTRIBUTOR]:
       formattingMultiplier: 0.25
       wordValue: 0.1
+permitGeneration:
+  enabled: true

src/configuration/permit-generation-configuration.ts

@@ -0,0 +1,9 @@
+import { Static, Type } from "@sinclair/typebox";
+
+const permitGenerationConfigurationType = Type.Object({
+  enabled: Type.Boolean(),
+});
+
+export type PermitGenerationConfiguration = Static<typeof permitGenerationConfigurationType>;
+
+export default permitGenerationConfigurationType;

src/parser/command-line.ts

@@ -9,10 +9,16 @@ if (process.env.NODE_ENV === "test") {
   process.argv.splice(2);
   process.argv.push("-i");
   process.argv.push(`${process.env.TEST_ISSUE_URL}`);
+  process.argv.push("-n");
+  process.argv.push("100");
+  process.argv.push("-e");
+  process.argv.push("privateKey");
 }
 
 const program = new Command()
   .requiredOption("-i, --issue <url>", "The url of the issue to parse")
+  .requiredOption("-n, --evmNetworkId <number>", "The network ID", parseInt)
+  .requiredOption("-e, --evmPrivateEncrypted <key>", "The EVM private encrypted key")
   .option("-c, --config <path>", "The path to the desired configuration to use", "rewards-configuration.default.yml")
   .option("-f, --file <file>", "The target file to store the results in")
   .version(packageJson.version)

src/parser/permit-generation-module.ts

@@ -0,0 +1,120 @@
+import { context } from "@actions/github";
+import { Value } from "@sinclair/typebox/value";
+import { createClient } from "@supabase/supabase-js";
+import {
+  Context,
+  createAdapters,
+  Database,
+  encodePermits,
+  generatePayoutPermit,
+  SupportedEvents,
+  TokenType,
+} from "@ubiquibot/permit-generation";
+import configuration from "../configuration/config-reader";
+import contentEvaluatorConfig from "../configuration/content-evaluator-config";
+import { getOctokitInstance } from "../get-authentication-token";
+import { IssueActivity } from "../issue-activity";
+import { Module, Result } from "./processor";
+import program from "./command-line";
+
+interface Payload {
+  evmNetworkId: number;
+  issueUrl: string;
+  evmPrivateEncrypted: string;
+  issue: { id: number };
+}
+
+export class PermitGenerationModule implements Module {
+  readonly _configuration: PermitGenerationModule = configuration.permitGeneration;
+  readonly _supabase = createClient<Database>(process.env.SUPABASE_URL, process.env.SUPABASE_ANON_KEY);
+
+  async transform(data: Readonly<IssueActivity>, result: Result): Promise<Result> {
+    const payload: Context["payload"] & Payload = {
+      ...context.payload.inputs,
+      issueUrl: program.opts().issue,
+      evmPrivateEncrypted: program.opts().evmPrivateEncrypted,
+      evmNetworkId: program.opts().evmNetworkId,
+    };
+    const issueId = Number(payload.issueUrl.match(/[0-9]+$/)?.[1]);
+    payload.issue = {
+      id: issueId,
+    };
+    const env = process.env;
+    const eventName = context.eventName as SupportedEvents;
+    const octokit = getOctokitInstance();
+    const logger = {
+      debug(message: unknown, optionalParams: unknown) {
+        console.log(message, optionalParams);
+      },
+      error(message: unknown, optionalParams: unknown) {
+        console.error(message, optionalParams);
+      },
+      fatal(message: unknown, optionalParams: unknown) {
+        console.error(message, optionalParams);
+      },
+      info(message: unknown, optionalParams: unknown) {
+        console.log(message, optionalParams);
+      },
+      warn(message: unknown, optionalParams: unknown) {
+        console.warn(message, optionalParams);
+      },
+    };
+    const adapters = {} as ReturnType<typeof createAdapters>;
+
+    for (const [key, value] of Object.entries(result)) {
+      try {
+        const config: Context["config"] = {
+          evmNetworkId: payload.evmNetworkId,
+          evmPrivateEncrypted: payload.evmPrivateEncrypted,
+          permitRequests: [
+            {
+              amount: value.total,
+              userId: value.userId,
+              contributionType: "",
+              type: TokenType.ERC20,
+            },
+          ],
+        };
+        const permits = await generatePayoutPermit(
+          {
+            env,
+            eventName,
+            logger,
+            payload,
+            adapters: createAdapters(this._supabase, {
+              env,
+              eventName,
+              octokit,
+              config,
+              logger,
+              payload,
+              adapters,
+            }),
+            octokit,
+            config,
+          },
+          [
+            {
+              type: "ERC20",
+              userId: value.userId,
+              amount: value.total,
+              contributionType: "",
+            },
+          ]
+        );
+        result[key].permitUrl = `https://pay.ubq.fi?claim=${encodePermits(permits)}`;
+      } catch (e) {
+        console.error(e);
+      }
+    }
+    return Promise.resolve(result);
+  }
+
+  get enabled(): boolean {
+    if (!Value.Check(contentEvaluatorConfig, this._configuration)) {
+      console.warn("Invalid configuration detected for PermitGenerationModule, disabling.");
+      return false;
+    }
+    return this._configuration.enabled;
+  }
+}

src/parser/processor.ts

@@ -6,6 +6,7 @@ import program from "./command-line";
 import { ContentEvaluatorModule } from "./content-evaluator-module";
 import { DataPurgeModule } from "./data-purge-module";
 import { FormattingEvaluatorModule } from "./formatting-evaluator-module";
+import { PermitGenerationModule } from "./permit-generation-module";
 import { UserExtractorModule } from "./user-extractor-module";
 
 export class Processor {
@@ -17,7 +18,8 @@ export class Processor {
     this.add(new UserExtractorModule())
       .add(new DataPurgeModule())
       .add(new FormattingEvaluatorModule())
-      .add(new ContentEvaluatorModule());
+      .add(new ContentEvaluatorModule())
+      .add(new PermitGenerationModule());
   }
 
   add(transformer: Module) {
@@ -34,10 +36,10 @@ export class Processor {
       if (transformer.enabled) {
         this._result = await transformer.transform(data, this._result);
       }
-    }
-    // Aggregate total result
-    for (const item of Object.keys(this._result)) {
-      this._result[item].total = this._sumRewards(this._result[item]);
+      // Aggregate total result
+      for (const item of Object.keys(this._result)) {
+        this._result[item].total = this._sumRewards(this._result[item]);
+      }
     }
     return this._result;
   }
@@ -96,6 +98,8 @@ export interface Result {
     task?: {
       reward: number;
     };
+    permitUrl?: string;
+    userId: number;
   };
 }
 

src/parser/user-extractor-module.ts

@@ -65,6 +65,7 @@ export class UserExtractorModule implements Module {
           ...result[comment.user.login],
           total: 0,
           task,
+          userId: comment.user.id,
         };
       }
     }

src/types/env.d.ts

@@ -0,0 +1,13 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      GITHUB_TOKEN: string;
+      OPENAI_API_KEY: string;
+      X25519_PRIVATE_KEY: string;
+      SUPABASE_ANON_KEY: string;
+      SUPABASE_URL: string;
+    }
+  }
+}
+
+export {};