feat: incentive for PullRequest reviewers

package.json

@@ -34,15 +34,16 @@
     "@sinclair/typebox": "^0.25.9",
     "@supabase/supabase-js": "^2.4.0",
     "@types/ms": "^0.7.31",
+    "@types/parse5": "^7.0.0",
     "@typescript-eslint/eslint-plugin": "^5.59.11",
     "@typescript-eslint/parser": "^5.59.11",
     "@uniswap/permit2-sdk": "^1.2.0",
     "@vercel/ncc": "^0.34.0",
     "ajv": "^8.11.2",
     "ajv-formats": "^2.1.1",
     "axios": "^1.3.2",
-    "decimal.js": "^10.4.3",
     "copyfiles": "^2.4.1",
+    "decimal.js": "^10.4.3",
     "ethers": "^5.7.2",
     "husky": "^8.0.2",
     "jimp": "^0.22.4",

src/handlers/payout/post.ts

@@ -1,6 +1,16 @@
 import { getWalletAddress } from "../../adapters/supabase";
 import { getBotConfig, getBotContext, getLogger } from "../../bindings";
-import { addCommentToIssue, generatePermit2Signature, getAllIssueComments, getIssueDescription, getTokenSymbol, parseComments } from "../../helpers";
+import {
+  addCommentToIssue,
+  generatePermit2Signature,
+  getAllIssueComments,
+  getAllPullRequestReviews,
+  getAllPullRequests,
+  getIssueDescription,
+  getTokenSymbol,
+  parseComments,
+} from "../../helpers";
+import { gitLinkedIssueParser } from "../../helpers/parser";
 import { Incentives, MarkdownItem, Payload, StateReason, UserType } from "../../types";
 import { commentParser } from "../comment";
 import Decimal from "decimal.js";
@@ -121,6 +131,138 @@ export const incentivizeComments = async () => {
   await addCommentToIssue(comment, issue.number);
 };
 
+export const incentivizePullRequestReviews = async () => {
+  const logger = getLogger();
+  const {
+    mode: { incentiveMode, paymentPermitMaxPrice },
+    price: { baseMultiplier, incentives },
+    payout: { paymentToken, rpc },
+  } = getBotConfig();
+  if (!incentiveMode) {
+    logger.info(`No incentive mode. skipping to process`);
+    // return;
+  }
+  const context = getBotContext();
+  const payload = context.payload as Payload;
+  const issue = payload.issue;
+  if (!issue) {
+    logger.info(`Incomplete payload. issue: ${issue}`);
+    return;
+  }
+
+  if (issue.state_reason !== StateReason.COMPLETED) {
+    logger.info("incentivizePullRequestReviews: comment incentives skipped because the issue was not closed as completed");
+    // return;
+  }
+
+  if (paymentPermitMaxPrice == 0 || !paymentPermitMaxPrice) {
+    logger.info(`incentivizePullRequestReviews: skipping to generate permit2 url, reason: { paymentPermitMaxPrice: ${paymentPermitMaxPrice}}`);
+    // return;
+  }
+
+  const issueDetailed = bountyInfo(issue);
+  if (!issueDetailed.isBounty) {
+    logger.info(`incentivizePullRequestReviews: its not a bounty`);
+    // return;
+  }
+
+  const pulls = await getAllPullRequests(context, "closed");
+  if (pulls.length === 0) {
+    logger.debug(`incentivizePullRequestReviews: No pull requests found at this time`);
+    return;
+  }
+
+  let linkedPull;
+
+  for (const pull of pulls) {
+    const pullRequestLinked = await gitLinkedIssueParser({
+      owner: payload.repository.owner.login,
+      repo: payload.repository.name,
+      issue_number: pull.number,
+    });
+    const linkedIssueNumber = pullRequestLinked.substring(pullRequestLinked.lastIndexOf("/") + 1);
+    if (linkedIssueNumber === issue.number.toString()) {
+      linkedPull = pull;
+      break;
+    }
+  }
+
+  if (!linkedPull) {
+    logger.debug(`incentivizePullRequestReviews: No linked pull requests found`);
+    return;
+  }
+
+  const comments = await getAllIssueComments(issue.number);
+  const permitComments = comments.filter(
+    (content) => content.body.includes("Reviewer Rewards") && content.body.includes("https://pay.ubq.fi?claim=") && content.user.type == UserType.Bot
+  );
+  if (permitComments.length > 0) {
+    logger.info(`incentivizePullRequestReviews: skip to generate a permit url because it has been already posted`);
+    return;
+  }
+
+  const assignees = issue?.assignees ?? [];
+  const assignee = assignees.length > 0 ? assignees[0] : undefined;
+  if (!assignee) {
+    logger.info("incentivizePullRequestReviews: skipping payment permit generation because `assignee` is `undefined`.");
+    return;
+  }
+
+  const prReviews = await getAllPullRequestReviews(context, linkedPull.number);
+  logger.info(`Getting the PR reviews done. comments: ${JSON.stringify(prReviews)}`);
+  const prReviewsByUser: Record<string, string[]> = {};
+  for (const review of prReviews) {
+    const user = review.user;
+    if (!user) continue;
+    if (user.type == UserType.Bot || user.login == assignee) continue;
+    if (!review.body) {
+      logger.info(`incentivizePullRequestReviews: Skipping to parse the comment because body_html is undefined. comment: ${JSON.stringify(review)}`);
+      continue;
+    }
+    if (!prReviewsByUser[user.login]) {
+      prReviewsByUser[user.login] = [];
+    }
+    prReviewsByUser[user.login].push(review.body);
+  }
+  const tokenSymbol = await getTokenSymbol(paymentToken, rpc);
+  logger.info(`incentivizePullRequestReviews: Filtering by the user type done. commentsByUser: ${JSON.stringify(prReviewsByUser)}`);
+
+  // The mapping between gh handle and comment with a permit url
+  const reward: Record<string, string> = {};
+
+  // The mapping between gh handle and amount in ETH
+  const fallbackReward: Record<string, Decimal> = {};
+  let comment = `#### Reviewer Rewards\n`;
+  for (const user of Object.keys(prReviewsByUser)) {
+    const comments = prReviewsByUser[user];
+    const commentsByNode = await parseComments(comments, ItemsToExclude);
+    const rewardValue = calculateRewardValue(commentsByNode, incentives);
+    if (rewardValue.equals(0)) {
+      logger.info(`incentivizePullRequestReviews: Skipping to generate a permit url because the reward value is 0. user: ${user}`);
+      continue;
+    }
+    logger.info(`incentivizePullRequestReviews: Comment parsed for the user: ${user}. comments: ${JSON.stringify(commentsByNode)}, sum: ${rewardValue}`);
+    const account = await getWalletAddress(user);
+    const amountInETH = rewardValue.mul(baseMultiplier).div(1000);
+    if (amountInETH.gt(paymentPermitMaxPrice)) {
+      logger.info(`incentivizePullRequestReviews: Skipping comment reward for user ${user} because reward is higher than payment permit max price`);
+      continue;
+    }
+    if (account) {
+      const { payoutUrl } = await generatePermit2Signature(account, amountInETH, issue.node_id);
+      comment = `${comment}### [ **${user}: [ CLAIM ${amountInETH} ${tokenSymbol.toUpperCase()} ]** ](${payoutUrl})\n`;
+      reward[user] = payoutUrl;
+    } else {
+      fallbackReward[user] = amountInETH;
+    }
+  }
+
+  logger.info(`incentivizePullRequestReviews: Permit url generated for pull request reviewers. reward: ${JSON.stringify(reward)}`);
+  logger.info(`incentivizePullRequestReviews: Skipping to generate a permit url for missing accounts. fallback: ${JSON.stringify(fallbackReward)}`);
+
+  await addCommentToIssue(comment, issue.number);
+};
+
 export const incentivizeCreatorComment = async () => {
   const logger = getLogger();
   const {

src/handlers/processors.ts

@@ -7,7 +7,7 @@ import { handleComment, issueClosedCallback, issueReopenedCallback } from "./com
 import { checkPullRequests } from "./assign/auto";
 import { createDevPoolPR } from "./pull-request";
 import { runOnPush } from "./push";
-import { incentivizeComments, incentivizeCreatorComment } from "./payout";
+import { incentivizeComments, incentivizeCreatorComment, incentivizePullRequestReviews } from "./payout";
 
 export const processors: Record<string, Handler> = {
   [GithubEvent.ISSUES_OPENED]: {
@@ -53,7 +53,7 @@ export const processors: Record<string, Handler> = {
   [GithubEvent.ISSUES_CLOSED]: {
     pre: [nullHandler],
     action: [issueClosedCallback],
-    post: [incentivizeCreatorComment, incentivizeComments],
+    post: [incentivizeCreatorComment, incentivizeComments, incentivizePullRequestReviews],
   },
   [GithubEvent.PULL_REQUEST_OPENED]: {
     pre: [nullHandler],

src/helpers/issue.ts

@@ -507,13 +507,13 @@ export const closePullRequest = async (pull_number: number) => {
   }
 };
 
-export const getAllPullRequestReviews = async (context: Context, pull_number: number) => {
+export const getAllPullRequestReviews = async (context: Context, pull_number: number, format: "raw" | "html" | "text" | "full" = "raw") => {
   const prArr = [];
   let fetchDone = false;
   const perPage = 30;
   let curPage = 1;
   while (!fetchDone) {
-    const prs = await getPullRequestReviews(context, pull_number, perPage, curPage);
+    const prs = await getPullRequestReviews(context, pull_number, perPage, curPage, format);
 
     // push the objects to array
     prArr.push(...prs);
@@ -524,7 +524,13 @@ export const getAllPullRequestReviews = async (context: Context, pull_number: nu
   return prArr;
 };
 
-export const getPullRequestReviews = async (context: Context, pull_number: number, per_page: number, page: number) => {
+export const getPullRequestReviews = async (
+  context: Context,
+  pull_number: number,
+  per_page: number,
+  page: number,
+  format: "raw" | "html" | "text" | "full" = "raw"
+) => {
   const logger = getLogger();
   const payload = context.payload as Payload;
   try {
@@ -534,6 +540,9 @@ export const getPullRequestReviews = async (context: Context, pull_number: numbe
       pull_number,
       per_page,
       page,
+      mediaType: {
+        format,
+      },
     });
     return reviews;
   } catch (e: unknown) {

src/helpers/parser.ts

@@ -25,19 +25,19 @@ export const gitIssueParser = async ({ owner, repo, issue_number }: GitParser):
   }
 };
 
-export const gitLinkedIssueParser = async ({ owner, repo, issue_number }: GitParser): Promise<string> => {
+export const gitLinkedIssueParser = async ({ owner, repo, issue_number: pull_number }: GitParser): Promise<string> => {
   try {
-    const { data } = await axios.get(`https://github.com/${owner}/${repo}/pull/${issue_number}`);
+    const { data } = await axios.get(`https://github.com/${owner}/${repo}/pull/${pull_number}`);
     const dom = parse(data);
     const devForm = dom.querySelector("[data-target='create-branch.developmentForm']") as HTMLElement;
-    const linkedPRs = devForm.querySelectorAll(".my-1");
+    const linkedIssues = devForm.querySelectorAll(".my-1");
 
-    if (linkedPRs.length === 0) {
+    if (linkedIssues.length === 0) {
       return "";
     }
 
-    const prUrl = linkedPRs[0].querySelector("a")?.attrs?.href || "";
-    return prUrl;
+    const issueUrl = linkedIssues[0].querySelector("a")?.attrs?.href || "";
+    return issueUrl;
   } catch (error) {
     return "";
   }