Merge pull request #1 from lemonjetx/UUPS

Universal Upgradeable Proxy Standard (UUPS)

Author: melonges

AGENTS.md

@@ -0,0 +1,36 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `src/` Solidity contracts (e.g., `LemonJetUpgradeable.sol`, `VaultUpgradeable.sol`); interfaces live in `src/interfaces/`.
+- `test/` Foundry tests (`*.t.sol`) and `test/mocks/` for mock contracts.
+- `script/` Foundry scripts (`*.s.sol`) with helpers in `script/utils/`.
+- `broadcast/` deployment artifacts per script/chain, `out/` build outputs, `cache/` local build cache.
+- `lib/` and `dependencies/` vendor libraries (forge-std, OpenZeppelin, Chainlink), configured via `foundry.toml` and `remappings.txt`.
+
+## Build, Test, and Development Commands
+- `forge build` (CI uses `forge build --sizes`) to compile contracts and report size.
+- `forge test` (CI uses `forge test -vvv`) to run the suite.
+- `forge fmt` or `forge fmt --check` to format or verify formatting.
+- `forge snapshot` to capture gas usage snapshots.
+- `anvil` to run a local EVM node for scripts and manual testing.
+- Example deploy script: `forge script script/LemonJet.s.sol:LemonJetScript --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY` (add `--broadcast` for live deploys).
+
+## Coding Style & Naming Conventions
+- Solidity version is 0.8.28 (`foundry.toml`); keep `pragma solidity ^0.8.28`.
+- Use 4-space indentation and let `forge fmt` normalize spacing/imports.
+- Contracts and files use PascalCase (`LemonJetUpgradeable.sol`), functions use camelCase.
+- Tests are `*.t.sol` with `*Test` contracts; revert cases often use `test_RevertWhen_...`.
+
+## Testing Guidelines
+- Tests use `forge-std/Test.sol` and a `setUp()` for fixtures.
+- Prefer targeted runs while iterating: `forge test --match-contract LemonJetTest` or `--match-test testPlayLjt`.
+- No explicit coverage threshold is defined; add regression tests alongside new behavior.
+
+## Commit & Pull Request Guidelines
+- Commit messages are short and imperative; some use conventional prefixes like `chore: fmt`. Stay consistent and keep the subject concise.
+- PRs should include a summary, motivation, tests run (or `not run` with reason), and any contract address changes or upgrade notes.
+
+## Security & Configuration Tips
+- Copy `.env.example` to `.env` and set `SEPOLIA_RPC_URL`, `PRIVATE_KEY`, `OWNER_ADDRESS`, `ETHERSCAN_API_KEY`.
+- Never commit private keys or `.env` contents.
+- FFI is enabled in `foundry.toml`; review scripts carefully before running untrusted code.

foundry.toml

@@ -5,7 +5,11 @@ libs = ["lib"]
 optimizer = true
 optimizer_runs = 20_000
 solc_version = "0.8.28"
-gas_reports = ["LemonJet"]
+gas_reports = ["LemonJetUpgradeable"]
+ffi = true
+ast = true
+build_info = true
+extra_output = ["storageLayout"]
 
 [rpc_endpoints]
 sepolia = "${SEPOLIA_RPC_URL}"

remappings.txt

@@ -1,8 +1,7 @@
 @chainlink-contracts-1.2.0/=dependencies/@chainlink-contracts-1.2.0/
 forge-std-1.9.3/=dependencies/forge-std-1.9.3/
-@pythnetwork/entropy-sdk-solidity/=node_modules/@pythnetwork/entropy-sdk-solidity
-@layerzerolabs/oft-evm/=lib/devtools/packages/oft-evm/
-@layerzerolabs/oapp-evm/=lib/devtools/packages/oapp-evm/
-@layerzerolabs/lz-evm-protocol-v2/=lib/layerzero-v2/packages/layerzero-v2/evm/protocol/
 @openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/
 @openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
+openzeppelin-contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/
+openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/
+openzeppelin-foundry-upgrades/=lib/openzeppelin-foundry-upgrades/src/

script/LJTFaucet.s.sol

@@ -3,21 +3,30 @@ pragma solidity ^0.8.13;
 
 import {Script} from "forge-std/Script.sol";
 import {console2} from "forge-std/console2.sol";
-import {ERC20Mock} from "openzeppelin-contracts/contracts/mocks/token/ERC20Mock.sol";
-import {LemonJet} from "../src/LemonJet.sol";
+import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
+import {LemonJetUpgradeable} from "../src/LemonJetUpgradeable.sol";
+import {IERC20} from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
 
 contract LemonJetDeployScript is Script {
     function run() external {
         uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
         address reserveFund = vm.envAddress("RESERVE_FUND_ADDRESS");
         address vrfWrapper = vm.envAddress("VRF_WRAPPER_ADDRESS");
         address vaultToken = vm.envAddress("VAULT_TOKEN_ADDRESS");
+
         vm.startBroadcast(deployerPrivateKey);
 
-        ERC20Mock asset = new ERC20Mock();
+        // Deploy a UUPS proxy with the LemonJetUpgradeable implementation
+        address proxy = Upgrades.deployUUPSProxy(
+            "LemonJetUpgradeable.sol:LemonJetUpgradeable",
+            abi.encodeCall(
+                LemonJetUpgradeable.initialize,
+                (vrfWrapper, reserveFund, IERC20(vaultToken), "LemonJet Vault", "LJUSDC")
+            )
+        );
+
+        console2.log("LemonJetUpgradeable UUPS proxy deployed at:", proxy);
 
-        LemonJet lemonJet = new LemonJet(vrfWrapper, reserveFund, address(asset), "LemonJet Vault", "LJUSDC");
-        console2.log(address(lemonJet));
         vm.stopBroadcast();
     }
 }

script/LemonJet.s.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.28;
 
 import {Script} from "forge-std/Script.sol";
 import {console2} from "forge-std/console2.sol";
-import {LemonJet} from "../src/LemonJet.sol";
+import {LemonJetUpgradeable} from "../src/LemonJetUpgradeable.sol";
 import {LemonJetToken} from "../test/mocks/LemonJetToken.sol";
 
 contract PlayLemonJetScript is Script {
@@ -14,7 +14,7 @@ contract PlayLemonJetScript is Script {
         //
         // (bool success,) = ljtGame.call{value: 1000000000000000, gas: 500000}(
         //     abi.encodeWithSelector(
-        //         LemonJet.play.selector, 111111, 200, address(0xBa0d95449B5E901CFb938fa6b6601281cEf679a4)
+        //         LemonJetUpgradeable.play.selector, 111111, 200, address(0xBa0d95449B5E901CFb938fa6b6601281cEf679a4)
         //     )
         // );
         // require(success, "Failed to send Ether");

script/Play.s.sol

@@ -4,10 +4,13 @@ pragma solidity 0.8.28;
 
 import {IERC20} from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
 import {ERC4626} from "openzeppelin-contracts/contracts/token/ERC20/extensions/ERC4626.sol";
+import {
+    ERC4626Upgradeable
+} from "openzeppelin-contracts-upgradeable/contracts/token/ERC20/extensions/ERC4626Upgradeable.sol";
 import {SafeERC20} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
 
 /// @dev ERC4626 vault with exit fees expressed in https://en.wikipedia.org/wiki/Basis_point[basis point (bp)].
-abstract contract ERC4626Fees is ERC4626 {
+abstract contract ERC4626FeesUpgradeable is ERC4626Upgradeable {
     uint256 internal constant _BASIS_POINT_SCALE = 1e4;
     uint256 internal constant _exitFeeBasisPoints = 60; // 0.6%
 

src/ERC4626Fees.sol

@@ -3,16 +3,22 @@ pragma solidity 0.8.28;
 
 import {SafeERC20} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
 import {IERC20} from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
-import {
-    VRFV2PlusWrapperConsumerBase
-} from "@chainlink-contracts-1.2.0/src/v0.8/vrf/dev/VRFV2PlusWrapperConsumerBase.sol";
-
+import {VRFV2PlusWrapperConsumerBaseUpgradeable} from "./VRFV2PlusWrapperConsumerBase.sol";
 import {Math} from "openzeppelin-contracts/contracts/utils/math/Math.sol";
 import {ILemonJet} from "./interfaces/ILemonJet.sol";
-import {Vault} from "./Vault.sol";
+import {VaultUpgradeable} from "./VaultUpgradeable.sol";
 import {Referral} from "./Referral.sol";
-
-contract LemonJet is ILemonJet, Referral, Vault, VRFV2PlusWrapperConsumerBase {
+import {OwnableUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol";
+import {UUPSUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
+
+contract LemonJetUpgradeable is
+    ILemonJet,
+    Referral,
+    VaultUpgradeable,
+    VRFV2PlusWrapperConsumerBaseUpgradeable,
+    OwnableUpgradeable,
+    UUPSUpgradeable
+{
     using SafeERC20 for IERC20;
 
     uint8 private constant STARTED = 1;
@@ -30,18 +36,27 @@ contract LemonJet is ILemonJet, Referral, Vault, VRFV2PlusWrapperConsumerBase {
         uint8 status; // 0, 1, 2
     }
 
-    constructor(
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        _disableInitializers();
+    }
+
+    function initialize(
         //  VRF Wrapper 2.5 for Direct Funding
         address wrapperAddress,
         // EOA which receives a fee
         address _reserveFund,
         // ERC20 token for ERC4626 Vault
-        address _asset,
+        IERC20 _asset,
         // Vault shares token name
         string memory _name,
         // Vault shares token symbol
         string memory _symbol
-    ) VRFV2PlusWrapperConsumerBase(wrapperAddress) Vault(_asset, _reserveFund, _name, _symbol) {}
+    ) public initializer {
+        VRFV2PlusWrapperConsumerBaseUpgradeable.initialize(wrapperAddress);
+        VaultUpgradeable.initialize(_asset, _reserveFund, _name, _symbol);
+        __Ownable_init(msg.sender);
+    }
 
     function play(uint256 bet, uint32 coef, address referrer) external payable {
         referrer = _setReferrerIfNotExists(referrer);
@@ -112,7 +127,7 @@ contract LemonJet is ILemonJet, Referral, Vault, VRFV2PlusWrapperConsumerBase {
         // check if a player has won
         if (randomNumber <= gameThreshold) {
             /**
-             * @dev See {Vault-_payoutWin}.
+             * @dev See {VaultUpgradeable-_payoutWin}.
              */
             _payoutWin(player, payout);
         } else {
@@ -153,4 +168,7 @@ contract LemonJet is ILemonJet, Referral, Vault, VRFV2PlusWrapperConsumerBase {
     function claimNativeBalance() external {
         payable(reserveFund).transfer(address(this).balance);
     }
+
+    /// @dev Required by UUPSUpgradeable - only owner can upgrade
+    function _authorizeUpgrade(address newImplementation) internal virtual override onlyOwner {}
 }

src/LJTFaucet.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity 0.8.28;
+
+import {LinkTokenInterface} from "@chainlink-contracts-1.2.0/src/v0.8/shared/interfaces/LinkTokenInterface.sol";
+import {IVRFV2PlusWrapper} from "@chainlink-contracts-1.2.0/src/v0.8/vrf/dev/interfaces/IVRFV2PlusWrapper.sol";
+import {Initializable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
+
+abstract contract VRFV2PlusWrapperConsumerBaseUpgradeable is Initializable {
+    error OnlyVRFWrapperCanFulfill(address have, address want);
+
+    IVRFV2PlusWrapper public i_vrfV2PlusWrapper;
+
+    /**
+     * @param _vrfV2PlusWrapper is the address of the VRFV2Wrapper contract
+     */
+    function initialize(address _vrfV2PlusWrapper) internal onlyInitializing {
+        i_vrfV2PlusWrapper = IVRFV2PlusWrapper(_vrfV2PlusWrapper);
+    }
+
+    // solhint-disable-next-line chainlink-solidity/prefix-internal-functions-with-underscore
+    function requestRandomnessPayInNative(
+        uint32 _callbackGasLimit,
+        uint16 _requestConfirmations,
+        uint32 _numWords,
+        bytes memory extraArgs
+    ) internal returns (uint256 requestId, uint256 requestPrice) {
+        requestPrice = i_vrfV2PlusWrapper.calculateRequestPriceNative(_callbackGasLimit, _numWords);
+        return (
+            i_vrfV2PlusWrapper.requestRandomWordsInNative{value: requestPrice}(
+                _callbackGasLimit, _requestConfirmations, _numWords, extraArgs
+            ),
+            requestPrice
+        );
+    }
+
+    /**
+     * @notice fulfillRandomWords handles the VRF V2 wrapper response. The consuming contract must
+     * @notice implement it.
+     *
+     * @param _requestId is the VRF V2 request ID.
+     * @param _randomWords is the randomness result.
+     */
+    // solhint-disable-next-line chainlink-solidity/prefix-internal-functions-with-underscore
+    function fulfillRandomWords(uint256 _requestId, uint256[] memory _randomWords) internal virtual;
+
+    function rawFulfillRandomWords(uint256 _requestId, uint256[] memory _randomWords) external {
+        address vrfWrapperAddr = address(i_vrfV2PlusWrapper);
+        if (msg.sender != vrfWrapperAddr) {
+            revert OnlyVRFWrapperCanFulfill(msg.sender, vrfWrapperAddr);
+        }
+        fulfillRandomWords(_requestId, _randomWords);
+    }
+
+    /// @notice getBalance returns the native balance of the consumer contract
+    function getBalance() public view returns (uint256) {
+        return address(this).balance;
+    }
+}