Use upgradeable proxies for tokens and collections #128
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.24; | ||
|
|
||
| import "@openzeppelin/contracts/utils/Create2.sol"; | ||
| import {LibString} from "solady/utils/LibString.sol"; | ||
| import "./FixedFungibleERC20.sol"; | ||
| import "./libraries/Proxy.sol"; | ||
| import "./Ethscriptions.sol"; | ||
| import "./libraries/Predeploys.sol"; | ||
| import "./interfaces/IProtocolHandler.sol"; | ||
|
|
@@ -12,7 +13,6 @@ import "./interfaces/IProtocolHandler.sol"; | |
| /// @notice Implements the fixed-fungible token protocol enforced via Ethscriptions transfers | ||
| /// @dev Deploys and controls FixedFungible ERC-20 clones; callable only by the Ethscriptions contract | ||
| contract FixedFungibleProtocolHandler is IProtocolHandler { | ||
| using LibString for string; | ||
|
|
||
| // ============================================================= | ||
|
|
@@ -50,8 +50,8 @@ contract FixedFungibleProtocolHandler is IProtocolHandler { | |
| // CONSTANTS | ||
| // ============================================================= | ||
|
|
||
| /// @dev Implementation contract used for proxy deployments | ||
| address public constant fixedFungibleImplementation = Predeploys.FIXED_FUNGIBLE_TEMPLATE_IMPLEMENTATION; | ||
| address public constant ethscriptions = Predeploys.ETHSCRIPTIONS; | ||
| string public constant CANONICAL_PROTOCOL = "fixed-fungible"; | ||
| string public constant PRETTY_PROTOCOL = "Fixed-Fungible"; | ||
|
|
@@ -140,25 +140,29 @@ contract FixedFungibleProtocolHandler is IProtocolHandler { | |
| if (deployOp.mintAmount == 0) revert InvalidMintAmount(); | ||
| if (deployOp.maxSupply % deployOp.mintAmount != 0) revert MaxSupplyNotDivisibleByMintAmount(); | ||
|
|
||
| // Deploy a Proxy via CREATE2 with this handler as temporary admin for initialization | ||
| Proxy tokenProxy = new Proxy{salt: tickKey}(address(this)); | ||
|
Comment on lines
+143
to
+144
There was a problem hiding this comment. The handler contract temporarily assumes admin privileges during initialization. If this function can be called multiple times or reentered before admin transfer, it creates a window where the handler has elevated privileges. Consider adding reentrancy protection or documenting this assumption explicitly. |
||
|
|
||
| // Build name/symbol and initialization calldata | ||
| string memory name = string.concat(PRETTY_PROTOCOL, " ", deployOp.tick); | ||
| string memory symbol = LibString.upper(deployOp.tick); | ||
| // Initialize with max supply in 18 decimals | ||
| // User maxSupply "1000000" means 1000000 * 10^18 smallest units | ||
| bytes memory initCalldata = abi.encodeWithSelector( | ||
| FixedFungibleERC20.initialize.selector, | ||
| name, | ||
| symbol, | ||
| deployOp.maxSupply * 10**18, | ||
| ethscriptionId | ||
| ); | ||
| // Set implementation and run initialize as admin | ||
| tokenProxy.upgradeToAndCall(fixedFungibleImplementation, initCalldata); | ||
| // Hand off admin to global ProxyAdmin so upgrades require system governance | ||
| tokenProxy.changeAdmin(Predeploys.PROXY_ADMIN); | ||
|
|
||
| // Store token info | ||
| tokensByTick[tickKey] = TokenInfo({ | ||
| tokenContract: address(tokenProxy), | ||
| deployEthscriptionId: ethscriptionId, | ||
| tick: deployOp.tick, | ||
| maxSupply: deployOp.maxSupply, | ||
|
|
@@ -171,7 +175,7 @@ contract FixedFungibleProtocolHandler is IProtocolHandler { | |
|
|
||
| emit FixedFungibleTokenDeployed( | ||
| ethscriptionId, | ||
| address(tokenProxy), | ||
| deployOp.tick, | ||
| deployOp.maxSupply, | ||
| deployOp.mintAmount | ||
|
|
@@ -290,8 +294,9 @@ contract FixedFungibleProtocolHandler is IProtocolHandler { | |
| return tokensByTick[tickKey].tokenContract; | ||
| } | ||
|
|
||
| // Predict using CREATE2 for Proxy with constructor arg (admin = address(this)) | ||
| bytes memory creationCode = abi.encodePacked(type(Proxy).creationCode, abi.encode(address(this))); | ||
| return Create2.computeAddress(tickKey, keccak256(creationCode), address(this)); | ||
| } | ||
|
|
||
| /// @notice Check if an ethscription is a token item | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,6 @@ contract Proxy { | |
| bytes calldata _data | ||
| ) | ||
| public | ||
| virtual | ||
| proxyCallIfNotAdmin | ||
| returns (bytes memory) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.24; | ||
|
|
||
| import "forge-std/Test.sol"; | ||
| import "../src/libraries/Predeploys.sol"; | ||
| import "../src/libraries/Proxy.sol"; | ||
| import "../src/FixedFungibleProtocolHandler.sol"; | ||
| import "../src/CollectionsProtocolHandler.sol"; | ||
| import "../src/Ethscriptions.sol"; | ||
| import "@openzeppelin/contracts/utils/Create2.sol"; | ||
| import "./TestSetup.sol"; | ||
|
|
||
| contract AddressPredictionTest is TestSetup { | ||
| // Test predictable address for FixedFungibleProtocolHandler token proxies | ||
| function testPredictFixedFungibleTokenAddress() public { | ||
| // Arrange | ||
| string memory tick = "eths"; | ||
| bytes32 deployTxHash = keccak256("deploy-eths"); | ||
|
|
||
| // Prepare deploy op data | ||
| FixedFungibleProtocolHandler.DeployOperation memory deployOp = FixedFungibleProtocolHandler.DeployOperation({ | ||
| tick: tick, | ||
| maxSupply: 1_000_000, | ||
| mintAmount: 1_000 | ||
| }); | ||
| bytes memory data = abi.encode(deployOp); | ||
|
|
||
| // Prediction via contract helper | ||
| address predicted = fixedFungibleHandler.predictTokenAddressByTick(tick); | ||
|
|
||
| // Act: call deploy as Ethscriptions (authorized) | ||
| vm.prank(Predeploys.ETHSCRIPTIONS); | ||
| fixedFungibleHandler.op_deploy(deployTxHash, data); | ||
|
|
||
| // Assert actual matches predicted | ||
| address actual = fixedFungibleHandler.getTokenAddressByTick(tick); | ||
| assertEq(actual, predicted, "Predicted token address should match actual deployed proxy"); | ||
| } | ||
|
|
||
| // Test predictable address for CollectionsProtocolHandler collection proxies | ||
| function testPredictCollectionsAddress() public { | ||
| // Arrange | ||
| bytes32 collectionId = keccak256("collection-1"); | ||
|
|
||
| CollectionsProtocolHandler.CollectionMetadata memory metadata = CollectionsProtocolHandler.CollectionMetadata({ | ||
| name: "My Collection", | ||
| symbol: "MYC", | ||
| totalSupply: 1000, | ||
| description: "A test collection", | ||
| logoImageUri: "data:,logo", | ||
| bannerImageUri: "data:,banner", | ||
| backgroundColor: "#000000", | ||
| websiteLink: "https://example.com", | ||
| twitterLink: "", | ||
| discordLink: "" | ||
| }); | ||
|
|
||
| // Manually compute predicted proxy address | ||
| bytes memory creationCode = abi.encodePacked(type(Proxy).creationCode, abi.encode(address(collectionsHandler))); | ||
| address predicted = Create2.computeAddress(collectionId, keccak256(creationCode), address(collectionsHandler)); | ||
|
|
||
| // Act: create collection as Ethscriptions (authorized) | ||
| vm.prank(Predeploys.ETHSCRIPTIONS); | ||
| collectionsHandler.op_create_collection(collectionId, abi.encode(metadata)); | ||
|
|
||
| // Assert deployed matches predicted | ||
| (address actual,,,) = collectionsHandler.collectionState(collectionId); | ||
| assertEq(actual, predicted, "Predicted collection address should match actual deployed proxy"); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The handler contract temporarily assumes admin privileges during initialization. If this function can be called multiple times or reentered before admin transfer, it creates a window where the handler has elevated privileges. Consider adding reentrancy protection or documenting this assumption explicitly.