Skip to content

Commit

Permalink
update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@miquelcabot
miquelcabot committed Jan 12, 2023
1 parent 5397dd3 commit cc19b27
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions contracts/SoulName.sol
View file
Expand Up @@ -69,7 +69,7 @@ contract SoulName is MasaNFT, ISoulName, ReentrancyGuard {
/* ========== RESTRICTED FUNCTIONS ====================================== */

/// @notice Sets the SoulboundIdentity contract address linked to this soul name
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _soulboundIdentity Address of the SoulboundIdentity contract
function setSoulboundIdentity(ISoulboundIdentity _soulboundIdentity)
external
Expand All @@ -81,7 +81,7 @@ contract SoulName is MasaNFT, ISoulName, ReentrancyGuard {
}

/// @notice Sets the extension of the soul name
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _extension Extension of the soul name
function setExtension(string memory _extension) external onlyOwner {
if (
Expand All @@ -92,7 +92,7 @@ contract SoulName is MasaNFT, ISoulName, ReentrancyGuard {
}

/// @notice Sets the URI of the smart contract metadata
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _contractURI URI of the smart contract metadata
function setContractURI(string memory _contractURI) external onlyOwner {
if (
Expand Down
4 changes: 2 additions & 2 deletions contracts/SoulStore.sol
View file
Expand Up @@ -82,7 +82,7 @@ contract SoulStore is PaymentGateway, Pausable, ReentrancyGuard, EIP712 {
}

/// @notice Adds a new authority to the list of authorities
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _authority New authority to add
function addAuthority(address _authority) external onlyOwner {
if (_authority == address(0)) revert ZeroAddress();
Expand All @@ -92,7 +92,7 @@ contract SoulStore is PaymentGateway, Pausable, ReentrancyGuard, EIP712 {
}

/// @notice Removes an authority from the list of authorities
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _authority Authority to remove
function removeAuthority(address _authority) external onlyOwner {
if (_authority == address(0)) revert ZeroAddress();
Expand Down
2 changes: 1 addition & 1 deletion contracts/SoulboundIdentity.sol
View file
Expand Up @@ -34,7 +34,7 @@ contract SoulboundIdentity is
/* ========== RESTRICTED FUNCTIONS ====================================== */

/// @notice Sets the SoulName contract address linked to this identity
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _soulName Address of the SoulName contract
function setSoulName(ISoulName _soulName)
external
Expand Down
8 changes: 4 additions & 4 deletions contracts/tokens/MasaSBT.sol
View file
Expand Up @@ -54,7 +54,7 @@ abstract contract MasaSBT is
/* ========== RESTRICTED FUNCTIONS ====================================== */

/// @notice Sets the price for adding the link in SoulLinker in stable coin
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _addLinkPrice New price for adding the link in SoulLinker in stable coin
function setAddLinkPrice(uint256 _addLinkPrice)
external
Expand All @@ -65,7 +65,7 @@ abstract contract MasaSBT is
}

/// @notice Sets the price for adding the link in SoulLinker in MASA
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _addLinkPriceMASA New price for adding the link in SoulLinker in MASA
function setAddLinkPriceMASA(uint256 _addLinkPriceMASA)
external
Expand All @@ -76,7 +76,7 @@ abstract contract MasaSBT is
}

/// @notice Sets the price for reading data in SoulLinker in stable coin
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _queryLinkPrice New price for reading data in SoulLinker in stable coin
function setQueryLinkPrice(uint256 _queryLinkPrice)
external
Expand All @@ -87,7 +87,7 @@ abstract contract MasaSBT is
}

/// @notice Sets the price for reading data in SoulLinker in MASA
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _queryLinkPriceMASA New price for reading data in SoulLinker in MASA
function setQueryLinkPriceMASA(uint256 _queryLinkPriceMASA)
external
Expand Down
8 changes: 4 additions & 4 deletions contracts/tokens/MasaSBTSelfSovereign.sol
View file
Expand Up @@ -72,7 +72,7 @@ abstract contract MasaSBTSelfSovereign is PaymentGateway, MasaSBT, EIP712 {
}

/// @notice Sets the price of minting in stable coin
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _mintPrice New price of minting in stable coin
function setMintPrice(uint256 _mintPrice)
external
Expand All @@ -83,7 +83,7 @@ abstract contract MasaSBTSelfSovereign is PaymentGateway, MasaSBT, EIP712 {
}

/// @notice Sets the price of minting in MASA
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _mintPriceMASA New price of minting in MASA
function setMintPriceMASA(uint256 _mintPriceMASA)
external
Expand All @@ -94,7 +94,7 @@ abstract contract MasaSBTSelfSovereign is PaymentGateway, MasaSBT, EIP712 {
}

/// @notice Adds a new authority to the list of authorities
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _authority New authority to add
function addAuthority(address _authority)
external
Expand All @@ -107,7 +107,7 @@ abstract contract MasaSBTSelfSovereign is PaymentGateway, MasaSBT, EIP712 {
}

/// @notice Removes an authority from the list of authorities
/// @dev The caller must have the admin to call this function
/// @dev The caller must have the admin role to call this function
/// @param _authority Authority to remove
function removeAuthority(address _authority)
external
Expand Down

0 comments on commit cc19b27

Please sign in to comment.