Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/bonus points payments #785

Merged
merged 8 commits into from
Dec 12, 2024
Merged

Feat/bonus points payments #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea1a4c4
chore: now issues with completed/pending bonus can't receive more bon…
fonstack Nov 28, 2024
8bacf88
new shared version
fonstack Dec 2, 2024
5eb1837
Merge remote-tracking branch 'origin/develop' into feat/bonus-points-…
fonstack Dec 2, 2024
50c24a3
Merge remote-tracking branch 'origin/fix/fix-safe-sdk-migration' into…
fonstack Dec 2, 2024
459f51c
chore: bonus points payments
fonstack Dec 3, 2024
04f88e2
chore: minor fixes
fonstack Dec 4, 2024
c36ea59
chore: removed log
fonstack Dec 10, 2024
c93f3bd
fixes
fonstack Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions packages/shared/src/types/payout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,28 @@ export type GithubIssue = {
createdBy: number;
labels: string[];
validLabels: string[];
createdAt: string;
body: string;
txHash?: string;
severity?: string;
bonusPointsLabels: {
needsFix: boolean;
needsTest: boolean;
};
};

export type GithubPR = {
id: number;
number: number;
title: string;
createdBy: number;
labels: string[];
createdAt: string;
body: string;
txHash?: string;
bonusSubmissionStatus: "COMPLETE" | "INCOMPLETE" | "PENDING";
linkedIssueNumber?: number;
linkedIssue?: GithubIssue;
};

export type IPayoutData = ISinglePayoutData | ISplitPayoutData;
Expand All @@ -80,7 +95,7 @@ export interface ISinglePayoutData extends IPayoutDataBase {
nftUrl: string;
submissionData?: { id: string; subId: string; idx: number };
decryptedSubmission?: Omit<ISubmittedSubmission, "linkedVault">; // Omit: workaround to avoid circular dependency;
ghIssue?: GithubIssue;
ghIssue?: GithubIssue | GithubPR;
}

// Only for v2 vaults
Expand All @@ -106,7 +121,7 @@ export interface ISplitPayoutBeneficiary {
nftUrl: string;
submissionData?: { id: string; subId: string; idx: number };
decryptedSubmission?: Omit<ISubmittedSubmission, "linkedVault">; // Omit: workaround to avoid circular dependency;
ghIssue?: GithubIssue;
ghIssue?: GithubIssue | GithubPR;
}

export interface IPayoutSignature {
Expand Down
2 changes: 2 additions & 0 deletions packages/web/src/languages/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,8 @@
"bonusPointsReminder": "Remember, you have 12 hours to submit after claiming. Happy fixing and testing!",
"bonusPointsEnabled": "Enable bonus points?",
"claimFixAndTest": "Claim fix and test",
"issueAlreadyHaveValidSubmission": "This issue already have a valid submission. You can submit complementary submission in other issue.",
"oneSubmissionIsBeingReviewed": "One submission is being reviewed. Please wait, if the submission is not complete, you can submit another one.",
"MyWallet": {
"overview": "Overview",
"pointValue": "Point value",
Expand Down
7 changes: 7 additions & 0 deletions packages/web/src/pages/CommitteeTools/PayoutsTool/PayoutFormPage/PayoutFormPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,13 @@ export const PayoutFormPage = () => {
});
}
} else {
if (vault.description["project-metadata"].bonusPointsEnabled) {
severities.push({
label: "Complementary",
value: "complementary",
});
}

for (const splitPayoutBeneficiary of payout.payoutData.beneficiaries) {
if (
splitPayoutBeneficiary.severity &&
Expand Down
28 changes: 22 additions & 6 deletions ...mponents/PayoutAllocation/SplitPayoutAllocation/components/SplitPayoutBeneficiaryForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { GithubIssue, IPayoutResponse, ISplitPayoutData, IVault } from "@hats.finance/shared";
import { GithubIssue, GithubPR, IPayoutResponse, ISplitPayoutData, IVault } from "@hats.finance/shared";
import DeleteIcon from "@mui/icons-material/DeleteOutlineOutlined";
import InfoIcon from "@mui/icons-material/InfoOutlined";
import MoreIcon from "@mui/icons-material/MoreVertOutlined";
Expand All @@ -8,7 +8,12 @@ import useModal from "hooks/useModal";
import { useOnChange } from "hooks/usePrevious";
import { hasSubmissionData } from "pages/CommitteeTools/PayoutsTool/utils/hasSubmissionData";
import { SubmissionCard } from "pages/CommitteeTools/SubmissionsTool/SubmissionsListPage/SubmissionCard";
import { getGhIssueFromSubmission, getGithubIssuesFromVault } from "pages/CommitteeTools/SubmissionsTool/submissionsService.api";
import {
getGhIssueFromSubmission,
getGhPRFromSubmission,
getGithubIssuesFromVault,
getGithubPRsFromVault,
} from "pages/CommitteeTools/SubmissionsTool/submissionsService.api";
import { useVaultSubmissionsByKeystore } from "pages/CommitteeTools/SubmissionsTool/submissionsService.hooks";
import { useEffect, useState } from "react";
import { Controller, UseFieldArrayRemove, useWatch } from "react-hook-form";
Expand Down Expand Up @@ -99,6 +104,7 @@ export const SplitPayoutBeneficiaryForm = ({
});

const [vaultGithubIssues, setVaultGithubIssues] = useState<GithubIssue[] | undefined>(undefined);
const [vaultGithubPRs, setVaultGithubPRs] = useState<GithubPR[] | undefined>(undefined);
const [isLoadingGH, setIsLoadingGH] = useState<boolean>(false);
fonstack marked this conversation as resolved.
Show resolved Hide resolved

// Get information from github
Expand All @@ -113,6 +119,12 @@ export const SplitPayoutBeneficiaryForm = ({
setIsLoadingGH(false);
};
loadGhIssues();

const loadGhPRs = async () => {
const ghPRs = await getGithubPRsFromVault(vault);
setVaultGithubPRs(ghPRs);
};
loadGhPRs();
}, [vault, vaultGithubIssues, beneficiarySubmission, isLoadingGH]);

const getMoreOptions = () => {
Expand Down Expand Up @@ -153,6 +165,10 @@ export const SplitPayoutBeneficiaryForm = ({
];
};

const selectedSubmission = isPayoutCreated
? beneficiaries[index]?.decryptedSubmission ?? beneficiarySubmission!
: beneficiarySubmission!;

return (
<div>
<div className="mb-1">{index + 1}.</div>
Expand All @@ -166,10 +182,10 @@ export const SplitPayoutBeneficiaryForm = ({
submission={
isPayoutCreated ? beneficiaries[index]?.decryptedSubmission ?? beneficiarySubmission! : beneficiarySubmission!
}
ghIssue={getGhIssueFromSubmission(
isPayoutCreated ? beneficiaries[index]?.decryptedSubmission ?? beneficiarySubmission! : beneficiarySubmission!,
vaultGithubIssues
)}
ghIssue={
getGhIssueFromSubmission(selectedSubmission, vaultGithubIssues) ||
getGhPRFromSubmission(selectedSubmission, vaultGithubPRs, vaultGithubIssues)
}
/>
</div>
) : (
Expand Down
50 changes: 39 additions & 11 deletions packages/web/src/pages/CommitteeTools/PayoutsTool/utils/autocalculateMultiPayout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { ISplitPayoutBeneficiary, ISplitPayoutData } from "@hats.finance/shared";
import { GithubPR, ISplitPayoutBeneficiary, ISplitPayoutData } from "@hats.finance/shared";
import millify from "millify";

const BONUS_POINTS_CONSTRAINTS = {
fix: 0.1, // 10%
test: 0.05, // 5%
};

const DECIMALS_TO_USE = 4;

// type IMultipayoutCalculation = ISplitPayoutBeneficiary[];
Expand Down Expand Up @@ -98,16 +103,39 @@ export const autocalculateMultiPayoutPointingSystem = (

const needPoints = beneficiaries.every((ben) => ben.percentageOfPayout === "" || ben.percentageOfPayout === undefined);
for (let beneficiary of beneficiaries) {
const sevInfo = constraints.find((constraint) => constraint.severity.toLowerCase() === beneficiary.severity.toLowerCase());
const defaultPoints = sevInfo?.points ? `${sevInfo.points.value.first}` : "1";

const beneficiaryCalculated: IBeneficiaryWithCalcs = {
...beneficiary,
percentageOfPayout: needPoints ? defaultPoints : beneficiary.percentageOfPayout,
amount: 0,
calculatedReward: 0,
};
beneficiariesCalculated.push(beneficiaryCalculated);
if (beneficiary.severity.toLowerCase() === "complementary") {
const mainIssueSev = (beneficiary.ghIssue as GithubPR).linkedIssue?.severity;
const mainIssueSevInfo = constraints.find(
(constraint) => constraint.severity.toLowerCase() === mainIssueSev?.toLowerCase()
);
const mainIssuePoints = mainIssueSevInfo?.points ? `${mainIssueSevInfo.points.value.first}` : "1";

let totalMultiplier = 0;
Comment on lines +106 to +112
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add type guard and null checks for mainIssueSev

The current implementation has potential type safety issues. Consider adding proper type guards and null checks.

-      const mainIssueSev = (beneficiary.ghIssue as GithubPR).linkedIssue?.severity;
+      if (!isGithubPR(beneficiary.ghIssue)) {
+        throw new Error('Expected GitHub PR for complementary submission');
+      }
+      const mainIssueSev = beneficiary.ghIssue.linkedIssue?.severity;
+      if (!mainIssueSev) {
+        throw new Error('Linked issue severity is required for complementary submission');
+      }

Where isGithubPR is defined as:

function isGithubPR(issue: any): issue is GithubPR {
  return issue && 'linkedIssue' in issue;
}


if (beneficiary.ghIssue?.labels?.includes("complete-fix")) totalMultiplier += BONUS_POINTS_CONSTRAINTS.fix;
if (beneficiary.ghIssue?.labels?.includes("complete-test")) totalMultiplier += BONUS_POINTS_CONSTRAINTS.test;

const complementaryPoints = totalMultiplier * +mainIssuePoints;

const beneficiaryCalculated: IBeneficiaryWithCalcs = {
...beneficiary,
percentageOfPayout: needPoints ? `${complementaryPoints.toFixed(4)}` : beneficiary.percentageOfPayout,
amount: 0,
calculatedReward: 0,
};
beneficiariesCalculated.push(beneficiaryCalculated);
} else {
const sevInfo = constraints.find((constraint) => constraint.severity.toLowerCase() === beneficiary.severity.toLowerCase());
const defaultPoints = sevInfo?.points ? `${sevInfo.points.value.first}` : "1";

const beneficiaryCalculated: IBeneficiaryWithCalcs = {
...beneficiary,
percentageOfPayout: needPoints ? defaultPoints : beneficiary.percentageOfPayout,
amount: 0,
calculatedReward: 0,
};
beneficiariesCalculated.push(beneficiaryCalculated);
}
}

const totalPointsToPay = beneficiariesCalculated.reduce((prev, curr) => prev + +curr.percentageOfPayout, 0);
Expand Down
58 changes: 47 additions & 11 deletions packages/web/src/pages/CommitteeTools/SubmissionsTool/SubmissionsListPage/SubmissionCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { GithubIssue, ISubmittedSubmission, IVulnerabilitySeverity, parseSeverityName } from "@hats.finance/shared";
import { GithubIssue, GithubPR, ISubmittedSubmission, IVulnerabilitySeverity, parseSeverityName } from "@hats.finance/shared";
import ArrowIcon from "@mui/icons-material/ArrowForwardOutlined";
import BoxUnselected from "@mui/icons-material/CheckBoxOutlineBlankOutlined";
import BoxSelected from "@mui/icons-material/CheckBoxOutlined";
Expand All @@ -18,7 +18,7 @@ type SubmissionCardProps = {
inPayout?: boolean;
isChecked?: boolean;
onCheckChange?: (submission: ISubmittedSubmission) => void;
ghIssue?: GithubIssue;
ghIssue?: GithubIssue | GithubPR;
};

export const SubmissionCard = ({
Expand All @@ -37,6 +37,12 @@ export const SubmissionCard = ({
const commChannel = submissionData?.communicationChannel;
const severityColors = getSeveritiesColorsArray(vault);

const isGithubPR = (issue: GithubIssue | GithubPR): issue is GithubPR => {
return "linkedIssueNumber" in issue;
};

const isComplementary = ghIssue ? isGithubPR(ghIssue) && !!ghIssue.linkedIssueNumber : false;

const createdAt = new Date(+submission?.createdAt * 1000);

const severityIndex =
Expand Down Expand Up @@ -67,25 +73,55 @@ export const SubmissionCard = ({
<div className="content">
{submissionData?.severity && (
<span className="severity">
{ghIssue && (
{ghIssue && !isComplementary && (
<span>
{t("ghIssue")} #{ghIssue.number} -
</span>
)}
<span>{t("submittedAs")}:</span>
{!isComplementary && <span>{t("submittedAs")}:</span>}
<Pill
textColor={severityColors[severityIndex ?? 0]}
isSeverity={!ghIssue}
text={parseSeverityName(submissionData?.severity) ?? t("noSeverity")}
/>
{ghIssue && ghIssue?.validLabels.length > 0 && (
{ghIssue && isComplementary ? (
(() => {
const getText = () => {
const labels = (ghIssue as GithubPR).labels;
if (labels.includes("complete-fix") && labels.includes("complete-test")) {
return `COMPLETE (fix & test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
} else if (labels.includes("complete-fix")) {
return `COMPLETE (fix) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
} else if (labels.includes("complete-test")) {
return `COMPLETE (test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
}

return (ghIssue as GithubPR).bonusSubmissionStatus;
};

Comment on lines +89 to +100
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Simplify status text generation and remove type assertions

The status text generation logic can be improved in several ways:

  1. Remove type assertions using the type guard
  2. Extract string literals to constants
  3. Simplify the logic using a map or switch statement
+const LABEL_TYPES = {
+  FIX: 'complete-fix',
+  TEST: 'complete-test'
+} as const;
+
+const STATUS_MESSAGES = {
+  BOTH: (severity: string) => `COMPLETE (fix & test) -> ${severity}`,
+  FIX: (severity: string) => `COMPLETE (fix) -> ${severity}`,
+  TEST: (severity: string) => `COMPLETE (test) -> ${severity}`
+} as const;
+
 const getText = () => {
-  const labels = (ghIssue as GithubPR).labels;
+  if (!isGithubPR(ghIssue)) return '';
+  const { labels, linkedIssue, bonusSubmissionStatus } = ghIssue;
+  const severity = linkedIssue?.severity;
+  
+  if (!severity) return bonusSubmissionStatus;
   
-  if (labels.includes("complete-fix") && labels.includes("complete-test")) {
-    return `COMPLETE (fix & test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
-  } else if (labels.includes("complete-fix")) {
-    return `COMPLETE (fix) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
-  } else if (labels.includes("complete-test")) {
-    return `COMPLETE (test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
-  }
+  const hasFix = labels.includes(LABEL_TYPES.FIX);
+  const hasTest = labels.includes(LABEL_TYPES.TEST);
   
-  return (ghIssue as GithubPR).bonusSubmissionStatus;
+  if (hasFix && hasTest) return STATUS_MESSAGES.BOTH(severity);
+  if (hasFix) return STATUS_MESSAGES.FIX(severity);
+  if (hasTest) return STATUS_MESSAGES.TEST(severity);
+  
+  return bonusSubmissionStatus;
 };
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const getText = () => {
const labels = (ghIssue as GithubPR).labels;
if (labels.includes("complete-fix") && labels.includes("complete-test")) {
return `COMPLETE (fix & test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
} else if (labels.includes("complete-fix")) {
return `COMPLETE (fix) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
} else if (labels.includes("complete-test")) {
return `COMPLETE (test) -> ${(ghIssue as GithubPR).linkedIssue?.severity}`;
}
return (ghIssue as GithubPR).bonusSubmissionStatus;
};
const LABEL_TYPES = {
FIX: 'complete-fix',
TEST: 'complete-test'
} as const;
const STATUS_MESSAGES = {
BOTH: (severity: string) => `COMPLETE (fix & test) -> ${severity}`,
FIX: (severity: string) => `COMPLETE (fix) -> ${severity}`,
TEST: (severity: string) => `COMPLETE (test) -> ${severity}`
} as const;
const getText = () => {
if (!isGithubPR(ghIssue)) return '';
const { labels, linkedIssue, bonusSubmissionStatus } = ghIssue;
const severity = linkedIssue?.severity;
if (!severity) return bonusSubmissionStatus;
const hasFix = labels.includes(LABEL_TYPES.FIX);
const hasTest = labels.includes(LABEL_TYPES.TEST);
if (hasFix && hasTest) return STATUS_MESSAGES.BOTH(severity);
if (hasFix) return STATUS_MESSAGES.FIX(severity);
if (hasTest) return STATUS_MESSAGES.TEST(severity);
return bonusSubmissionStatus;
};

return (
<>
<span>{t("status")}:</span>
<Pill
textColor={(ghIssue as GithubPR).bonusSubmissionStatus === "COMPLETE" ? "#3ee136" : "#bab441"}
isSeverity
text={getText()}
/>
</>
);
})()
) : (
<>
<span>{t("labeledAs")}:</span>
<Pill
textColor={severityColors[severityIndex ?? 0]}
isSeverity
text={parseSeverityName(ghIssue.validLabels[0])}
/>
{ghIssue && (ghIssue as GithubIssue)?.validLabels?.length > 0 && (
<>
<span>{t("labeledAs")}:</span>
<Pill
textColor={severityColors[severityIndex ?? 0]}
isSeverity
text={parseSeverityName((ghIssue as GithubIssue).validLabels[0])}
/>
</>
)}
</>
)}
</span>
Expand Down
Loading
Loading