Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: more naming occurrences #65

Merged
merged 1 commit into from
Dec 17, 2024
Merged

fix: more naming occurrences #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/MetaMorphoV1_1Factory.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import {ErrorsLib} from "./libraries/ErrorsLib.sol";

import {MetaMorphoV1_1} from "./MetaMorphoV1_1.sol";

/// @title MetaMorphoFactory
/// @title MetaMorphoV1_1Factory
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do the following instead ?

Suggested change
/// @title MetaMorphoV1_1Factory
/// @title MetaMorphoFactoryV1_1

/// @author Morpho Labs
/// @custom:contact security@morpho.org
/// @notice This contract allows to create MetaMorpho vaults, and to index them easily.
/// @notice This contract allows to create MetaMorphoV1_1 vaults, and to index them easily.
contract MetaMorphoV1_1Factory is IMetaMorphoV1_1Factory {
/* IMMUTABLES */

Expand Down
9 changes: 5 additions & 4 deletions src/interfaces/IMetaMorphoV1_1.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ interface IOwnable {
function pendingOwner() external view returns (address);
}

/// @dev This interface is used for factorizing IMetaMorphoV1_1StaticTyping and IMetaMorpho.
/// @dev This interface is used for factorizing IMetaMorphoV1_1StaticTyping and IMetaMorphoV1_1.
/// @dev Consider using the IMetaMorphoV1_1 interface instead of this one.
interface IMetaMorphoV1_1Base {
/// @notice The address of the Morpho contract.
Expand Down Expand Up @@ -188,7 +188,7 @@ interface IMetaMorphoV1_1Base {
function reallocate(MarketAllocation[] calldata allocations) external;
}

/// @dev This interface is inherited by MetaMorpho so that function signatures are checked by the compiler.
/// @dev This interface is inherited by MetaMorphoV1_1 so that function signatures are checked by the compiler.
/// @dev Consider using the IMetaMorphoV1_1 interface instead of this one.
interface IMetaMorphoV1_1StaticTyping is IMetaMorphoV1_1Base {
/// @notice Returns the current configuration of each market.
Expand All @@ -204,10 +204,11 @@ interface IMetaMorphoV1_1StaticTyping is IMetaMorphoV1_1Base {
function pendingTimelock() external view returns (uint192 value, uint64 validAt);
}

/// @title IMetaMorpho
/// @title IMetaMorphoV1_1
/// @author Morpho Labs
/// @custom:contact security@morpho.org
/// @dev Use this interface for MetaMorpho to have access to all the functions with the appropriate function signatures.
/// @dev Use this interface for MetaMorphoV1_1 to have access to all the functions with the appropriate function
/// signatures.
interface IMetaMorphoV1_1 is IMetaMorphoV1_1Base, IERC4626, IERC20Permit, IOwnable, IMulticall {
/// @notice Returns the current configuration of each market.
function config(Id) external view returns (MarketConfig memory);
Expand Down
8 changes: 4 additions & 4 deletions src/interfaces/IMetaMorphoV1_1Factory.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ import {IMetaMorphoV1_1} from "./IMetaMorphoV1_1.sol";
/// @title IMetaMorphoV1_1Factory
/// @author Morpho Labs
/// @custom:contact security@morpho.org
/// @notice Interface of MetaMorpho's factory.
/// @notice Interface of MetaMorphoV1_1's factory.
interface IMetaMorphoV1_1Factory {
/// @notice The address of the Morpho contract.
function MORPHO() external view returns (address);

/// @notice Whether a MetaMorpho vault was created with the factory.
/// @notice Whether a MetaMorphoV1_1 vault was created with the factory.
function isMetaMorpho(address target) external view returns (bool);

/// @notice Creates a new MetaMorpho vault.
/// @notice Creates a new MetaMorphoV1_1 vault.
/// @param initialOwner The owner of the vault.
/// @param initialTimelock The initial timelock of the vault.
/// @param asset The address of the underlying asset.
/// @param name The name of the vault.
/// @param symbol The symbol of the vault.
/// @param salt The salt to use for the MetaMorpho vault's CREATE2 address.
/// @param salt The salt to use for the MetaMorphoV1_1 vault's CREATE2 address.
function createMetaMorpho(
address initialOwner,
uint256 initialTimelock,
Expand Down
14 changes: 7 additions & 7 deletions src/libraries/EventsLib.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,15 @@ library EventsLib {
/// @notice Emitted when an `amount` of `token` is transferred to the skim recipient by `caller`.
event Skim(address indexed caller, address indexed token, uint256 amount);

/// @notice Emitted when a new MetaMorpho vault is created.
/// @param metaMorpho The address of the MetaMorpho vault.
/// @notice Emitted when a new MetaMorphoV1_1 vault is created.
/// @param metaMorpho The address of the MetaMorphoV1_1 vault.
/// @param caller The caller of the function.
/// @param initialOwner The initial owner of the MetaMorpho vault.
/// @param initialTimelock The initial timelock of the MetaMorpho vault.
/// @param initialOwner The initial owner of the MetaMorphoV1_1 vault.
/// @param initialTimelock The initial timelock of the MetaMorphoV1_1 vault.
/// @param asset The address of the underlying asset.
/// @param name The name of the MetaMorpho vault.
/// @param symbol The symbol of the MetaMorpho vault.
/// @param salt The salt used for the MetaMorpho vault's CREATE2 address.
/// @param name The name of the MetaMorphoV1_1 vault.
/// @param symbol The symbol of the MetaMorphoV1_1 vault.
/// @param salt The salt used for the MetaMorphoV1_1 vault's CREATE2 address.
event CreateMetaMorpho(
address indexed metaMorpho,
address indexed caller,
Expand Down
Loading