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.

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 typos #217

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 contracts/interfaces/IDeBridgeGate.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IFeeProxy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
2 changes: 1 addition & 1 deletion contracts/libraries/Flags.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions contracts/libraries/MultiSendCallOnly.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -58,4 +58,4 @@ contract MultiSendCallOnly {
}
}
}
}
}
2 changes: 1 addition & 1 deletion contracts/mock/MockProxyReceiverAlwaysReverting.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

}
4 changes: 2 additions & 2 deletions contracts/periphery/CallProxy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -231,4 +231,4 @@ contract CallProxy is Initializable, AccessControlUpgradeable, MultiSendCallOnly
function version() external pure returns (uint256) {
return 424; // 4.2.4
}
}
}
2 changes: 1 addition & 1 deletion contracts/periphery/DeBridgeToken.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions contracts/transfers/DeBridgeGate.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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
}
Expand Down
4 changes: 2 additions & 2 deletions contracts/transfers/SignatureVerifier.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -154,4 +154,4 @@ contract SignatureVerifier is OraclesManager, ISignatureVerifier {
function version() external pure returns (uint256) {
return 202; // 2.0.2
}
}
}
2 changes: 1 addition & 1 deletion docs/contracts/libraries/Flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/contracts/transfers/DeBridgeGate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down