some rfks, added audit

Author: erhant

.gitignore

@@ -9,6 +9,7 @@ coverage/
 !/broadcast
 /broadcast/*/31337/
 /broadcast/*/84532/
+!/broadcast/*/84532/run-latest.json
 /broadcast/**/dry-run/
 
 # Forge files

.vscode/settings.json

@@ -6,5 +6,6 @@
     "editor.defaultFormatter": "JuanBlanco.solidity"
   },
   "solidity.formatter": "forge",
-  "solidity.compileUsingRemoteVersion": "v0.8.26"
+  "solidity.compileUsingRemoteVersion": "v0.8.26",
+  "solidity.defaultCompiler": "localFile"
 }

README.md

@@ -158,6 +158,11 @@ To interact with the contracts, you need the contract ABIs. We store the ABIs un
 ./export-abis.sh
 ```
 
+### Upgrade Contract
+
+Upgrading an existing contract is done as per the instructions in [openzeppelin-foundry-upgrades](https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades) repository.
+The `--sender <ADDRESS>` field is required when deploying a contract,
+
 ## Testing & Diagnostics
 
 Run tests on local network:

abis/parseAbi.cjs

@@ -0,0 +1,24 @@
+const fs = require("fs");
+
+if (process.argv.length < 3) {
+  console.error("Please provide a filename as a parameter.");
+  process.exit(1);
+}
+
+const filename = process.argv[2];
+
+const data = fs.readFileSync(filename, "utf8");
+try {
+  const jsonData = JSON.parse(data);
+  const abi = jsonData.abi;
+  if (!abi) {
+    console.error("No `abi` field found in the JSON data.");
+    process.exit(1);
+  }
+
+  fs.writeFileSync(filename, JSON.stringify(abi, null, 2));
+  console.log("ABI extracted and written to", filename);
+} catch (parseErr) {
+  console.error(`Error parsing JSON: ${parseErr}`);
+  process.exit(1);
+}

abis/parseAbi.js

@@ -2,7 +2,7 @@
 forge compile
 
 cp ./out/LLMOracleCoordinator.sol/LLMOracleCoordinator.json ./abis/LLMOracleCoordinator.json
-node ./abis/parseAbi.js ./abis/LLMOracleCoordinator.json
+node ./abis/parseAbi.cjs ./abis/LLMOracleCoordinator.json
 
 cp ./out/LLMOracleRegistry.sol/LLMOracleRegistry.json ./abis/LLMOracleRegistry.json
-node ./abis/parseAbi.js ./abis/LLMOracleRegistry.json
+node ./abis/parseAbi.cjs ./abis/LLMOracleRegistry.json

audits/CodeHawks-28-11-2024.pdf

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Upgrades} from "@openzeppelin/foundry-upgrades/Upgrades.sol";
+import {Upgrades, UnsafeUpgrades} from "@openzeppelin/foundry-upgrades/Upgrades.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 import {Script} from "forge-std/Script.sol";
 import {Vm} from "forge-std/Vm.sol";
@@ -32,13 +32,13 @@ contract DeployLLMOracleRegistry is Script {
 
     function run() external returns (address proxy, address impl) {
         vm.startBroadcast();
-        (proxy, impl) = this.deployProxy();
+        (proxy, impl) = this.deploy();
         vm.stopBroadcast();
 
         helper.writeProxyAddresses("LLMOracleRegistry", proxy, impl);
     }
 
-    function deployProxy() external returns (address proxy, address impl) {
+    function deploy() external returns (address proxy, address impl) {
         proxy = Upgrades.deployUUPSProxy(
             "LLMOracleRegistry.sol",
             abi.encodeCall(
@@ -48,6 +48,15 @@ contract DeployLLMOracleRegistry is Script {
 
         impl = Upgrades.getImplementationAddress(proxy);
     }
+
+    function deployUnsafe(address impl) external returns (address proxy) {
+        proxy = UnsafeUpgrades.deployUUPSProxy(
+            impl,
+            abi.encodeCall(
+                LLMOracleRegistry.initialize, (stakes.generator, stakes.validator, token, minRegistrationTimeSec)
+            )
+        );
+    }
 }
 
 contract DeployLLMOracleCoordinator is Script {
@@ -74,8 +83,6 @@ contract DeployLLMOracleCoordinator is Script {
     }
 
     function run() external returns (address proxy, address impl) {
-        helper = new Helper();
-
         // read registry address
         string memory deployments = helper.getDeploymentsJson();
         require(vm.keyExistsJson(deployments, "$.LLMOracleRegistry"), "Please deploy LLMOracleRegistry first");
@@ -85,13 +92,13 @@ contract DeployLLMOracleCoordinator is Script {
         require(registryImlp != address(0), "LLMOracleRegistry implementation address is invalid");
 
         vm.startBroadcast();
-        (proxy, impl) = this.deployProxy(registryProxy);
+        (proxy, impl) = this.deploy(registryProxy);
         vm.stopBroadcast();
 
         helper.writeProxyAddresses("LLMOracleCoordinator", proxy, impl);
     }
 
-    function deployProxy(address registryAddr) external returns (address proxy, address impl) {
+    function deploy(address registryAddr) external returns (address proxy, address impl) {
         proxy = Upgrades.deployUUPSProxy(
             "LLMOracleCoordinator.sol",
             abi.encodeCall(
@@ -103,3 +110,38 @@ contract DeployLLMOracleCoordinator is Script {
         impl = Upgrades.getImplementationAddress(proxy);
     }
 }
+
+contract UpgradeLLMOracleRegistry is Script {
+    Helper public helper;
+    Stakes public stakes;
+    uint256 public minRegistrationTimeSec;
+    address public token;
+
+    constructor() {
+        helper = new Helper();
+
+        // parameters
+        minRegistrationTimeSec = 1 days;
+        stakes = Stakes({generator: 0.0001 ether, validator: 0.000001 ether});
+        token = address(0x4200000000000000000000000000000000000006); // WETH
+    }
+
+    function run() external returns (address proxy, address impl) {
+        vm.startBroadcast();
+        (proxy, impl) = this.deploy();
+        vm.stopBroadcast();
+
+        helper.writeProxyAddresses("LLMOracleRegistry", proxy, impl);
+    }
+
+    function deploy() external returns (address proxy, address impl) {
+        proxy = Upgrades.deployUUPSProxy(
+            "LLMOracleRegistry.sol",
+            abi.encodeCall(
+                LLMOracleRegistry.initialize, (stakes.generator, stakes.validator, token, minRegistrationTimeSec)
+            )
+        );
+
+        impl = Upgrades.getImplementationAddress(proxy);
+    }
+}