Commit dda5c26e authored by Kelvin Fichter's avatar Kelvin Fichter

fix(ctb): missing FeeVault comments

Adds missing constructor comments in the FeeVault contracts.
parent ab8cf2ea
...@@ -13,6 +13,8 @@ import { FeeVault } from "../universal/FeeVault.sol"; ...@@ -13,6 +13,8 @@ import { FeeVault } from "../universal/FeeVault.sol";
contract BaseFeeVault is FeeVault, Semver { contract BaseFeeVault is FeeVault, Semver {
/** /**
* @custom:semver 0.0.1 * @custom:semver 0.0.1
*
* @param _recipient Address that will receive the accumulated fees.
*/ */
constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {} constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {}
} }
...@@ -13,6 +13,8 @@ import { FeeVault } from "../universal/FeeVault.sol"; ...@@ -13,6 +13,8 @@ import { FeeVault } from "../universal/FeeVault.sol";
contract L1FeeVault is FeeVault, Semver { contract L1FeeVault is FeeVault, Semver {
/** /**
* @custom:semver 0.0.1 * @custom:semver 0.0.1
*
* @param _recipient Address that will receive the accumulated fees.
*/ */
constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {} constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {}
} }
...@@ -32,6 +32,8 @@ contract SequencerFeeVaultLegacySpacer { ...@@ -32,6 +32,8 @@ contract SequencerFeeVaultLegacySpacer {
contract SequencerFeeVault is SequencerFeeVaultLegacySpacer, FeeVault, Semver { contract SequencerFeeVault is SequencerFeeVaultLegacySpacer, FeeVault, Semver {
/** /**
* @custom:semver 0.0.1 * @custom:semver 0.0.1
*
* @param _recipient Address that will receive the accumulated fees.
*/ */
constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {} constructor(address _recipient) FeeVault(_recipient, 10 ether) Semver(0, 0, 1) {}
......
...@@ -6,11 +6,16 @@ import { Predeploys } from "../libraries/Predeploys.sol"; ...@@ -6,11 +6,16 @@ import { Predeploys } from "../libraries/Predeploys.sol";
/** /**
* @title FeeVault * @title FeeVault
* @notice The FeeVault contract has the base logic for handling transaction fees. * @notice The FeeVault contract contains the basic logic for the various different vault contracts
* used to hold fee revenue generated by the L2 system.
*/ */
abstract contract FeeVault { abstract contract FeeVault {
/** /**
* @notice Emits each time that a withdrawal occurs * @notice Emits each time that a withdrawal occurs.
*
* @param value Amount that was withdrawn (in wei).
* @param to Address that the funds were sent to.
* @param from Address that triggered the withdrawal.
*/ */
event Withdrawal(uint256 value, address to, address from); event Withdrawal(uint256 value, address to, address from);
...@@ -30,9 +35,8 @@ abstract contract FeeVault { ...@@ -30,9 +35,8 @@ abstract contract FeeVault {
uint256 public totalProcessed; uint256 public totalProcessed;
/** /**
* @param _recipient - The L1 account that funds can be withdrawn to. * @param _recipient Wallet that will receive the fees on L1.
* @param _minWithdrawalAmount - The min amount of funds before a withdrawal * @param _minWithdrawalAmount Minimum balance before a withdrawal can be triggered.
* can be triggered.
*/ */
constructor(address _recipient, uint256 _minWithdrawalAmount) { constructor(address _recipient, uint256 _minWithdrawalAmount) {
MIN_WITHDRAWAL_AMOUNT = _minWithdrawalAmount; MIN_WITHDRAWAL_AMOUNT = _minWithdrawalAmount;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment