From 7c57307612ebe4c6c67e3307e73ee3e38a7b5dba Mon Sep 17 00:00:00 2001 From: mike Date: Fri, 13 Dec 2024 14:11:08 +0100 Subject: [PATCH] Add comments improvements --- contracts/sfc/NodeDriverAuth.sol | 6 +++--- contracts/sfc/SFC.sol | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contracts/sfc/NodeDriverAuth.sol b/contracts/sfc/NodeDriverAuth.sol index 961dda6..359fca7 100644 --- a/contracts/sfc/NodeDriverAuth.sol +++ b/contracts/sfc/NodeDriverAuth.sol @@ -63,7 +63,7 @@ contract NodeDriverAuth is OwnableUpgradeable, UUPSUpgradeable { } /// Execute a batch update of network configuration. - /// Run given contract with a permission of the NodeDriverAuth owner. + /// The executable will run with the privileges of the NodeDriverAuth owner. /// Does not allow changing NodeDriver and NodeDriverAuth code. function execute(address executable) external onlyOwner { _execute(executable, owner(), _getCodeHash(address(this)), _getCodeHash(address(driver))); @@ -89,7 +89,7 @@ contract NodeDriverAuth is OwnableUpgradeable, UUPSUpgradeable { driver.setBalance(acc, address(acc).balance + diff); } - /// Upgrade code of given contract by coping it from other deployed contract. + /// Upgrade code of given contract by copying it from other deployed contract. /// Avoids setting code to an external address. function upgradeCode(address acc, address from) external onlyOwner { if (!isContract(acc) || !isContract(from)) { @@ -98,7 +98,7 @@ contract NodeDriverAuth is OwnableUpgradeable, UUPSUpgradeable { driver.copyCode(acc, from); } - /// Upgrade code of given contract by coping it from other deployed contract. + /// Upgrade code of given contract by copying it from other deployed contract. /// Does not avoid setting code to an external address. (DANGEROUS!) function copyCode(address acc, address from) external onlyOwner { driver.copyCode(acc, from); diff --git a/contracts/sfc/SFC.sol b/contracts/sfc/SFC.sol index 5b97ec3..ba56e16 100644 --- a/contracts/sfc/SFC.sol +++ b/contracts/sfc/SFC.sol @@ -273,7 +273,7 @@ contract SFC is OwnableUpgradeable, UUPSUpgradeable, Version { } /// Accept redirection proposal. - /// Redirection must by accepted by the validator key holder before it start to be applied. + /// Redirection must by accepted by the validator key holder before it starts to be applied. function redirect(address to) external { address from = msg.sender; if (to == address(0)) {