Skip to content

Commit

Permalink
Add NatSpec comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Phanco committed Jul 9, 2024
1 parent b7c617e commit 672409f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
7 changes: 6 additions & 1 deletion src/L1/paused/L1VestingWalletPaused.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.23;

import "src/L2/paused/L2VestingWalletPaused.sol";
import { L2VestingWalletPaused } from "src/L2/paused/L2VestingWalletPaused.sol";

/// @title L1VestingWalletPaused - Paused version of L1VestingWallet contract
/// @notice This contract is used to pause the L1VestingWallet contract. In case of any emergency, the owner can upgrade
/// and
/// pause the contract to prevent any further vesting operations.
/// L1VestingWalletPaused shares the same functionality of L1VestingWalletPaused.
contract L1VestingWalletPaused is L2VestingWalletPaused { }
11 changes: 10 additions & 1 deletion src/L2/paused/L2VestingWalletPaused.sol
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.23;

import "src/L2/L2VestingWallet.sol";
import { L2VestingWallet } from "src/L2/L2VestingWallet.sol";

/// @title L2VestingWalletPaused - Paused version of L2VestingWallet contract
/// @notice This contract is used to pause the L2VestingWallet contract. In case of any emergency, the owner can upgrade
/// and
/// pause the contract to prevent any further vesting operations.
contract L2VestingWalletPaused is L2VestingWallet {
error VestingWalletIsPaused();

Expand All @@ -11,22 +15,27 @@ contract L2VestingWalletPaused is L2VestingWallet {
version = "1.0.0-paused";
}

/// @notice Override the release function to prevent release of token from being processed.
function release(address) public virtual override {
revert VestingWalletIsPaused();
}

/// @notice Override the release function to prevent release of token from being processed.
function release() public virtual override {
revert VestingWalletIsPaused();
}

/// @notice Override the acceptOwnership function to prevent change of ownership from being processed.
function acceptOwnership() public virtual override {
revert VestingWalletIsPaused();
}

/// @notice Override the acceptOwnership function to prevent change of ownership from being processed.
function transferOwnership(address) public virtual override {
revert VestingWalletIsPaused();
}

/// @notice Override the acceptOwnership function to prevent change of ownership from being processed.
function renounceOwnership() public virtual override {
revert VestingWalletIsPaused();
}
Expand Down

0 comments on commit 672409f

Please sign in to comment.