-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: proper portal setup for fees + test (#7944)
Fixes #7692. Gets rid of assets directly in the rollup contract. The rollup contract will instead make a call to the portal to get it to pay some funds to the sequencer, currently named `distributeFees`. Calling initialize on the fee juice portal require that it have been funded to ensure that the deployment of the l2 fee assets does not lead to an undercollateralized case.
- Loading branch information
Showing
18 changed files
with
278 additions
and
192 deletions.
There are no files selected for viewing
This file contains 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,107 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Copyright 2024 Aztec Labs. | ||
| pragma solidity >=0.8.18; | ||
|
|
||
| import {IERC20} from "@oz/token/ERC20/IERC20.sol"; | ||
| import {SafeERC20} from "@oz/token/ERC20/utils/SafeERC20.sol"; | ||
| import {Ownable} from "@oz/access/Ownable.sol"; | ||
|
|
||
| // Messaging | ||
| import {IRegistry} from "./interfaces/messagebridge/IRegistry.sol"; | ||
| import {IInbox} from "./interfaces/messagebridge/IInbox.sol"; | ||
| import {IFeeJuicePortal} from "./interfaces/IFeeJuicePortal.sol"; | ||
| import {DataStructures} from "./libraries/DataStructures.sol"; | ||
| import {Errors} from "./libraries/Errors.sol"; | ||
| import {Constants} from "./libraries/ConstantsGen.sol"; | ||
| import {Hash} from "./libraries/Hash.sol"; | ||
|
|
||
| contract FeeJuicePortal is IFeeJuicePortal, Ownable { | ||
| using SafeERC20 for IERC20; | ||
|
|
||
| IRegistry public registry; | ||
| IERC20 public underlying; | ||
| bytes32 public l2TokenAddress; | ||
|
|
||
| constructor() Ownable(msg.sender) {} | ||
|
|
||
| /** | ||
| * @notice Initialize the FeeJuicePortal | ||
| * | ||
| * @dev This function is only callable by the owner of the contract and only once | ||
| * | ||
| * @dev Must be funded with FEE_JUICE_INITIAL_MINT tokens before initialization to | ||
| * ensure that the L2 contract is funded and able to pay for its deployment. | ||
| * | ||
| * @param _registry - The address of the registry contract | ||
| * @param _underlying - The address of the underlying token | ||
| * @param _l2TokenAddress - The address of the L2 token | ||
| */ | ||
| function initialize(address _registry, address _underlying, bytes32 _l2TokenAddress) | ||
| external | ||
| override(IFeeJuicePortal) | ||
| onlyOwner | ||
| { | ||
| if (address(registry) != address(0) || address(underlying) != address(0) || l2TokenAddress != 0) | ||
| { | ||
| revert Errors.FeeJuicePortal__AlreadyInitialized(); | ||
| } | ||
| if (_registry == address(0) || _underlying == address(0) || _l2TokenAddress == 0) { | ||
| revert Errors.FeeJuicePortal__InvalidInitialization(); | ||
| } | ||
|
|
||
| registry = IRegistry(_registry); | ||
| underlying = IERC20(_underlying); | ||
| l2TokenAddress = _l2TokenAddress; | ||
| uint256 balance = underlying.balanceOf(address(this)); | ||
| if (balance < Constants.FEE_JUICE_INITIAL_MINT) { | ||
| underlying.safeTransferFrom( | ||
| msg.sender, address(this), Constants.FEE_JUICE_INITIAL_MINT - balance | ||
| ); | ||
| } | ||
| _transferOwnership(address(0)); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Deposit funds into the portal and adds an L2 message which can only be consumed publicly on Aztec | ||
| * @param _to - The aztec address of the recipient | ||
| * @param _amount - The amount to deposit | ||
| * @param _secretHash - The hash of the secret consumable message. The hash should be 254 bits (so it can fit in a Field element) | ||
| * @return - The key of the entry in the Inbox | ||
| */ | ||
| function depositToAztecPublic(bytes32 _to, uint256 _amount, bytes32 _secretHash) | ||
| external | ||
| override(IFeeJuicePortal) | ||
| returns (bytes32) | ||
| { | ||
| // Preamble | ||
| IInbox inbox = registry.getRollup().INBOX(); | ||
| DataStructures.L2Actor memory actor = DataStructures.L2Actor(l2TokenAddress, 1); | ||
|
|
||
| // Hash the message content to be reconstructed in the receiving contract | ||
| bytes32 contentHash = | ||
| Hash.sha256ToField(abi.encodeWithSignature("mint_public(bytes32,uint256)", _to, _amount)); | ||
|
|
||
| // Hold the tokens in the portal | ||
| underlying.safeTransferFrom(msg.sender, address(this), _amount); | ||
|
|
||
| // Send message to rollup | ||
| return inbox.sendL2Message(actor, contentHash, _secretHash); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Let the rollup distribute fees to an account | ||
| * | ||
| * Since the assets cannot be exited the usual way, but only paid as fees to sequencers | ||
| * we include this function to allow the rollup to do just that, bypassing the usual | ||
| * flows. | ||
| * | ||
| * @param _to - The address to receive the payment | ||
| * @param _amount - The amount to pay them | ||
| */ | ||
| function distributeFees(address _to, uint256 _amount) external override(IFeeJuicePortal) { | ||
| if (msg.sender != address(registry.getRollup())) { | ||
| revert Errors.FeeJuicePortal__Unauthorized(); | ||
| } | ||
| underlying.safeTransfer(_to, _amount); | ||
| } | ||
| } |
This file contains 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 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,11 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Copyright 2024 Aztec Labs. | ||
| pragma solidity >=0.8.18; | ||
|
|
||
| interface IFeeJuicePortal { | ||
| function initialize(address _registry, address _underlying, bytes32 _l2TokenAddress) external; | ||
| function distributeFees(address _to, uint256 _amount) external; | ||
| function depositToAztecPublic(bytes32 _to, uint256 _amount, bytes32 _secretHash) | ||
| external | ||
| returns (bytes32); | ||
| } |
This file contains 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 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 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 was deleted.
Oops, something went wrong.
This file contains 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
Oops, something went wrong.