HumpyComp wrapper

.eslintignore

@@ -0,0 +1,22 @@
+node_modules
+.env
+dist
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+gas_report
+
+contracts/vendor
+
+# Hardhat deploy artifacts
+/deployments

.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ['plugin:@api3/eslint-plugin-commons/universal', 'plugin:@api3/eslint-plugin-commons/jest'],
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+  },
+  rules: {
+    camelcase: 'off',
+    'functional/no-try-statements': 'off',
+    'unicorn/filename-case': 'off',
+  },
+  ignorePatterns: ['typechain-types/*'],
+};

.github/config/linkspector.yml

@@ -0,0 +1,7 @@
+aliveStatusCodes:
+  - 200
+  - 406
+dirs:
+  - .
+  - .github
+useGitIgnore: true

.github/workflows/check-md-links.yml

@@ -0,0 +1,16 @@
+name: Check Markdown links
+
+on: push
+
+jobs:
+  check-md-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone @api3/data-feed-proxy-combinators
+        uses: actions/checkout@v6
+      - name: Check Markdown links
+        uses: umbrelladocs/action-linkspector@v1
+        with:
+          reporter: github-pr-review
+          config_file: .github/config/linkspector.yml
+          fail_on_error: true

.github/workflows/continuous-build.yml

@@ -0,0 +1,40 @@
+name: Continuous build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint-build-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone @api3/humpy-comp
+        uses: actions/checkout@v6
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Type check
+        run: pnpm tsc
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Test
+        run: pnpm test

.gitignore

@@ -0,0 +1,18 @@
+node_modules
+.env
+dist
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+# Hardhat deploy artifacts
+/deployments

.prettierignore

@@ -0,0 +1,22 @@
+node_modules
+.env
+dist
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+gas_report
+
+contracts/vendor
+
+# Hardhat deploy artifacts
+/deployments

.prettierrc

@@ -0,0 +1,27 @@
+{
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "parser": "markdown"
+      }
+    },
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "slang",
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}

.solhint.json

@@ -0,0 +1,13 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": "off",
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "not-rely-on-time": "off",
+    "no-empty-blocks": "off",
+    "no-global-import": "off",
+    "func-name-mixedcase": "off",
+    "immutable-vars-naming": "off",
+    "gas-custom-errors": "off"
+  }
+}

.solhintignore

@@ -0,0 +1,19 @@
+node_modules
+.env
+dist
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+gas_report
+
+./contracts/vendor

README.md

@@ -0,0 +1,23 @@
+# Humpy Comp
+
+ERC20 wrapper for COMP token that delegates voting power to another address.
+
+Set the required environment variable before deploying:
+
+Deploy on Ethereum:
+
+```
+INITIAL_DELEGATEE=0xDelegateeAddress pnpm deploy:humpy-comp:ethereum
+```
+
+Override initial owner:
+
+```
+INITIAL_DELEGATEE=0xDelegateeAddress OWNER=0xOwnerAddress pnpm run deploy:humpy-comp:ethereum
+```
+
+Deploy to a local mainnet fork (running on `localhost`) with:
+
+```
+INITIAL_DELEGATEE=0xDelegateeAddress pnpm deploy:humpy-comp:localhost
+```

contracts/HumpyComp.sol

@@ -0,0 +1,70 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.27;
+
+import {
+    Ownable,
+    Ownable2Step
+} from "@openzeppelin/contracts/access/Ownable2Step.sol";
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {ERC20Wrapper} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Wrapper.sol";
+import {IComp} from "./vendor/@compound-finance/compound-governance/contracts/interfaces/IComp.sol";
+
+/// @title Humpy COMP
+/// @author API3 DAO
+/// @notice 1:1 wrapper token for COMP built on OpenZeppelin ERC20Wrapper
+contract HumpyComp is ERC20Wrapper, Ownable2Step {
+    address internal constant COMP_ADDRESS =
+        0xc00e94Cb662C3520282E6f5717214004A7f26888;
+    IComp internal immutable comp = IComp(COMP_ADDRESS);
+
+    /// @notice Constructs the Humpy COMP wrapper
+    /// @param initialOwner Address of the initial owner
+    /// @param initialDelegatee Address of the initial delegatee for COMP voting power
+    constructor(
+        address initialOwner,
+        address initialDelegatee
+    )
+        ERC20("Humpy COMP", "HumpyCOMP")
+        ERC20Wrapper(IERC20(COMP_ADDRESS))
+        Ownable(initialOwner)
+    {
+        _setDelegatee(initialDelegatee);
+    }
+
+    /// @notice Returns the current COMP delegatee for voting power held by this wrapper
+    /// @return delegateeAddress Current delegatee address
+    function delegatee() external view returns (address) {
+        return comp.delegates(address(this));
+    }
+
+    /// @notice Wraps COMP tokens for the caller at a 1:1 ratio
+    /// @param value Amount of COMP to deposit
+    /// @return success Whether wrapping succeeded
+    function deposit(uint256 value) external returns (bool) {
+        return depositFor(msg.sender, value);
+    }
+
+    /// @notice Unwraps HumpyCOMP tokens for the caller at a 1:1 ratio
+    /// @param value Amount of HumpyCOMP to burn and withdraw as COMP
+    /// @return success Whether unwrapping succeeded
+    function withdraw(uint256 value) external returns (bool) {
+        return withdrawTo(msg.sender, value);
+    }
+
+    /**
+     * @notice Allows the owner to change who receives the aggregated voting power
+     * @param newDelegatee The new address to receive the COMP voting power
+     */
+    function setDelegatee(address newDelegatee) external onlyOwner {
+        _setDelegatee(newDelegatee);
+    }
+
+    /**
+     * @notice Updates delegated voting power recipient for COMP held by this wrapper
+     * @param newDelegatee New delegatee address
+     */
+    function _setDelegatee(address newDelegatee) internal {
+        comp.delegate(newDelegatee);
+    }
+}

contracts/test/MockComp.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {Comp} from "../vendor/@compound-finance/compound-governance/contracts/Comp.sol";
+
+contract MockComp is Comp {
+    constructor(address account) Comp(account) {}
+
+    function mint(address to, uint96 amount) external {
+        balances[to] += amount;
+        _moveDelegates(delegates[address(0)], delegates[to], amount);
+    }
+}