diff --git a/contracts/interfaces/IDeBridgeGate.sol b/contracts/interfaces/IDeBridgeGate.sol index fc4ff28f..64abf56c 100644 --- a/contracts/interfaces/IDeBridgeGate.sol +++ b/contracts/interfaces/IDeBridgeGate.sol @@ -92,7 +92,7 @@ interface IDeBridgeGate { /// (defined in the globalFixedNativeFee property). Any excess amount of ether passed to this function is /// included in the message as the execution fee - the amount deBridgeGate would give as an incentive to /// a third party in return for successful claim transaction execution on the destination chain. - /// @notice DeBridgeGate accepts a set of flags that control the behaviour of the execution. This simple method + /// @notice DeBridgeGate accepts a set of flags that control the behavior of the execution. This simple method /// sets the default set of flags: REVERT_IF_EXTERNAL_FAIL, PROXY_WITH_SENDER /// @param _dstChainId ID of the destination chain. /// @param _targetContractAddress A contract address to be called on the destination chain @@ -110,7 +110,7 @@ interface IDeBridgeGate { /// (defined in the globalFixedNativeFee property). Any excess amount of ether passed to this function is /// included in the message as the execution fee - the amount deBridgeGate would give as an incentive to /// a third party in return for successful claim transaction execution on the destination chain. - /// @notice DeBridgeGate accepts a set of flags that control the behaviour of the execution. This simple method + /// @notice DeBridgeGate accepts a set of flags that control the behavior of the execution. This simple method /// sets the default set of flags: REVERT_IF_EXTERNAL_FAIL, PROXY_WITH_SENDER /// @param _dstChainId ID of the destination chain. /// @param _targetContractAddress A contract address to be called on the destination chain diff --git a/contracts/interfaces/IFeeProxy.sol b/contracts/interfaces/IFeeProxy.sol index c0cfbf97..ec8fe354 100644 --- a/contracts/interfaces/IFeeProxy.sol +++ b/contracts/interfaces/IFeeProxy.sol @@ -4,6 +4,6 @@ pragma solidity ^0.8.7; interface IFeeProxy { function withdrawFee(address _tokenAddress) external payable; - /// @dev Swap Native tokens to deETH and then transfer reward to Ethereum network. + /// @dev Swap Native tokens to deETH and then transfer the reward to the Ethereum network. function withdrawNativeFee() external payable; } diff --git a/contracts/libraries/Flags.sol b/contracts/libraries/Flags.sol index 2b3c3339..e975a8fa 100644 --- a/contracts/libraries/Flags.sol +++ b/contracts/libraries/Flags.sol @@ -15,7 +15,7 @@ library Flags { uint256 public constant SEND_HASHED_DATA = 3; /// @dev First 24 bytes from data is gas limit for external call uint256 public constant SEND_EXTERNAL_CALL_GAS_LIMIT = 4; - /// @dev Support multi send for externall call + /// @dev Support multi send for external call uint256 public constant MULTI_SEND = 5; /// @dev Get flag diff --git a/contracts/libraries/MultiSendCallOnly.sol b/contracts/libraries/MultiSendCallOnly.sol index 9213462e..3b7c19d8 100644 --- a/contracts/libraries/MultiSendCallOnly.sol +++ b/contracts/libraries/MultiSendCallOnly.sol @@ -14,7 +14,7 @@ contract MultiSendCallOnly { /// data length as a uint256 (=> 32 bytes), /// data as bytes. /// see abi.encodePacked for more information on packed encoding - /// @notice The code is for most part the same as the normal MultiSend (to keep compatibility), + /// @notice The code is for the most part the same as the normal MultiSend (to keep compatibility), /// but reverts if a transaction tries to use a delegatecall. /// @notice This method is payable as delegatecalls keep the msg.value from the previous call /// If the calling method (e.g. execTransaction) received ETH this would revert otherwise @@ -58,4 +58,4 @@ contract MultiSendCallOnly { } } } -} \ No newline at end of file +} diff --git a/contracts/mock/MockProxyReceiverAlwaysReverting.sol b/contracts/mock/MockProxyReceiverAlwaysReverting.sol index 760234f1..5a5208e3 100644 --- a/contracts/mock/MockProxyReceiverAlwaysReverting.sol +++ b/contracts/mock/MockProxyReceiverAlwaysReverting.sol @@ -2,7 +2,7 @@ pragma solidity ^0.8.0; // MockProxyReceiverAlwaysReverting always fails on incoming ethers. -// Used in test cases of proxy when target fails to execute +// Used in test cases of proxy when the target fails to execute contract MockProxyReceiverAlwaysReverting { } diff --git a/contracts/periphery/CallProxy.sol b/contracts/periphery/CallProxy.sol index 53bd399d..ee39c4cb 100644 --- a/contracts/periphery/CallProxy.sol +++ b/contracts/periphery/CallProxy.sol @@ -145,7 +145,7 @@ contract CallProxy is Initializable, AccessControlUpgradeable, MultiSendCallOnly /// data length as a uint256 (=> 32 bytes), /// data as bytes. /// see abi.encodePacked for more information on packed encoding - /// @notice The code is for most part the same as the normal MultiSend (to keep compatibility), + /// @notice The code is for the most part the same as the normal MultiSend (to keep compatibility), /// but reverts if a transaction tries to use a delegatecall. /// @notice This method is payable as delegatecalls keep the msg.value from the previous call /// If the calling method (e.g. execTransaction) received ETH this would revert otherwise @@ -231,4 +231,4 @@ contract CallProxy is Initializable, AccessControlUpgradeable, MultiSendCallOnly function version() external pure returns (uint256) { return 424; // 4.2.4 } -} \ No newline at end of file +} diff --git a/contracts/periphery/DeBridgeToken.sol b/contracts/periphery/DeBridgeToken.sol index 5d8b0f97..aad37df8 100644 --- a/contracts/periphery/DeBridgeToken.sol +++ b/contracts/periphery/DeBridgeToken.sol @@ -6,7 +6,7 @@ import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20PausableUpgradeable.sol"; import "../interfaces/IDeBridgeToken.sol"; -/// @dev ERC20 token that is used as wrapped asset to represent the native token value on the other chains. +/// @dev ERC20 token that is used as a wrapped asset to represent the native token value on the other chains. contract DeBridgeToken is Initializable, AccessControlUpgradeable, diff --git a/contracts/transfers/DeBridgeGate.sol b/contracts/transfers/DeBridgeGate.sol index 67db1921..e9cc8bc7 100644 --- a/contracts/transfers/DeBridgeGate.sol +++ b/contracts/transfers/DeBridgeGate.sol @@ -49,7 +49,7 @@ contract DeBridgeGate is address public deBridgeTokenDeployer; /// @dev Current signature verifier address to verify signatures. address public signatureVerifier; - /// @dev Minimal required confirmations in case sent amount is big, have no effect if less than SignatureVerifier.minConfirmations + /// @dev Minimal required confirmations in case the sent amount is big, have no effect if less than SignatureVerifier.minConfirmations uint8 public excessConfirmations; /// @dev *obsolete flashFeeBps uint256 public gap0; @@ -563,7 +563,7 @@ contract DeBridgeGate is discountInfo.discountTransferBps = _discountTransferBps; } - // we need to accept ETH sends to unwrap WETH + // we need to accept ETH sent to unwrap WETH receive() external payable { // assert(msg.sender == address(weth)); // only accept ETH via fallback from the WETH contract } diff --git a/contracts/transfers/SignatureVerifier.sol b/contracts/transfers/SignatureVerifier.sol index 6af78c50..46879f36 100644 --- a/contracts/transfers/SignatureVerifier.sol +++ b/contracts/transfers/SignatureVerifier.sol @@ -122,7 +122,7 @@ contract SignatureVerifier is OraclesManager, ISignatureVerifier { confirmationThreshold = _confirmationThreshold; } - /// @dev Sets core debridge conrtact address. + /// @dev Sets core debridge contract address. /// @param _debridgeAddress Debridge address. function setDebridgeAddress(address _debridgeAddress) external onlyAdmin { debridgeAddress = _debridgeAddress; @@ -154,4 +154,4 @@ contract SignatureVerifier is OraclesManager, ISignatureVerifier { function version() external pure returns (uint256) { return 202; // 2.0.2 } -} \ No newline at end of file +} diff --git a/docs/contracts/libraries/Flags.md b/docs/contracts/libraries/Flags.md index 9a8be9e8..02e5f986 100644 --- a/docs/contracts/libraries/Flags.md +++ b/docs/contracts/libraries/Flags.md @@ -33,7 +33,7 @@ First 24 bytes from data is gas limit for external call ```solidity uint256 public constant MULTI_SEND; ``` -Support multi send for externall call +Support multi send for external call # Functions ## getFlag diff --git a/docs/contracts/transfers/DeBridgeGate.md b/docs/contracts/transfers/DeBridgeGate.md index 8191da47..0905e60f 100644 --- a/docs/contracts/transfers/DeBridgeGate.md +++ b/docs/contracts/transfers/DeBridgeGate.md @@ -174,7 +174,7 @@ DeBridgeGate only accepts submissions with msg.value (native ether) covering a s (defined in the globalFixedNativeFee property). Any excess amount of ether passed to this function is included in the message as the execution fee - the amount deBridgeGate would give as an incentive to a third party in return for successful claim transaction execution on the destination chain. -DeBridgeGate accepts a set of flags that control the behaviour of the execution. This simple method +DeBridgeGate accepts a set of flags that control the behavior of the execution. This simple method sets the default set of flags: REVERT_IF_EXTERNAL_FAIL, PROXY_WITH_SENDER Submits the message to the deBridge infrastructure to be broadcasted to another supported blockchain (identified by _dstChainId) @@ -200,7 +200,7 @@ DeBridgeGate only accepts submissions with msg.value (native ether) covering a s (defined in the globalFixedNativeFee property). Any excess amount of ether passed to this function is included in the message as the execution fee - the amount deBridgeGate would give as an incentive to a third party in return for successful claim transaction execution on the destination chain. -DeBridgeGate accepts a set of flags that control the behaviour of the execution. This simple method +DeBridgeGate accepts a set of flags that control the behavior of the execution. This simple method sets the default set of flags: REVERT_IF_EXTERNAL_FAIL, PROXY_WITH_SENDER Submits the message to the deBridge infrastructure to be broadcasted to another supported blockchain (identified by _dstChainId)