Merge pull request #565 from hats-finance/chore/new-gas-saving-descri…

…ption New default gas saving description
hats-finance · Oct 3, 2023 · a2f2088 · a2f2088
2 parents f871205 + 4ff3dcd
commit a2f2088
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hats-finance/shared",
-  "version": "1.1.28",
+  "version": "1.1.29",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/packages/shared/src/severities.ts b/packages/shared/src/severities.ts
@@ -52,7 +52,7 @@ export const AUDIT_SEVERITIES_V1: { [key: string]: IEditedVulnerabilitySeverityV
       image: "ipfs://QmZAuKhEivpnrhPyvhJyPGti4fGLLYQLqvUtRtvsL8wkuC/SmallSize-Low-Tech%20Sphere.mp4",
       external_url: "",
     },
-    description: `This competition will reward participants with ideas to maximize gas savings. The first place gets ⅔ (66.6%) of the prize pool, and the second place gets ⅓ (33.3%).\n    \nThe guidelines are as follows:\n* Submissions should be forks of our repository, with the test suite unchanged.\n* Optimizations should use solidity (no inline assembly).\n* Entries will be measured on the total average amount of gas used for each function (i.e., the sum of all numbers in the “avg” column), as reported by the hardhat-gas-reporter when running the tests in the repository.`,
+    description: `This competition will reward participants with ideas to maximize gas savings. The first place gets ⅔ (66.6%) of the prize pool, and the second place gets ⅓ (33.3%).\n\nSubmissions get classified on the basis of the average gas savings as reported by the gas reporter. The submission with the lowest average gas usage will win.\n    \nThe guidelines are as follows:\n* Changes should be limited to solidity files only. Tests should only be changed if they fail because of the changes in gas usage (e.g. tests that hardcode gas usage values).\n* Optimizations should use Solidity (no inline assembly).\n* All tests in the repository should pass.\n* The score of the submission is the total average amount of gas used for each function (i.e., the sum of all numbers in the “avg” column), as reported by the hardhat-gas-reporter when running the tests in the repository.\n* Submitters are kindly asked to include this number in their report, and can adapt this script for doing so: https://github.com/hats-finance/hats-contracts/blob/develop/gas-avg-check.py\n* Submissions should at least have a 5% improvement with respect to the original score.`,
   },
   low: {
     id: "low-audit",