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

docs(protocol)!: fix typos #16189

Merged
merged 4 commits into from
Feb 29, 2024
Merged
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 packages/protocol/contracts/L1/TaikoErrors.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ abstract contract TaikoErrors {
error L1_ASSIGNED_PROVER_NOT_ALLOWED();
error L1_BLOB_FOR_DA_DISABLED();
error L1_BLOB_NOT_FOUND();
error L1_BLOB_NOT_REUSEABLE();
error L1_BLOB_REUSE_DISALBED();
error L1_BLOB_NOT_REUSABLE();
error L1_BLOB_REUSE_DISABLED();
error L1_BLOCK_MISMATCH();
error L1_INVALID_BLOCK_ID();
error L1_INVALID_CONFIG();
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/contracts/L1/TaikoEvents.sol
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ abstract contract TaikoEvents {
/// @dev Emitted when a block is verified.
/// @param blockId The ID of the verified block.
/// @param assignedProver The block's assigned prover.
/// @param prover The prover whose transition is used for verifing the
/// @param prover The prover whose transition is used for verifying the
/// block.
/// @param blockHash The hash of the verified block.
/// @param stateRoot The block's state root.
Expand Down
8 changes: 4 additions & 4 deletions packages/protocol/contracts/L1/libs/LibProposing.sol
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ library LibProposing {
// Warning: Any errors defined here must also be defined in TaikoErrors.sol.
error L1_BLOB_FOR_DA_DISABLED();
error L1_BLOB_NOT_FOUND();
error L1_BLOB_NOT_REUSEABLE();
error L1_BLOB_REUSE_DISALBED();
error L1_BLOB_NOT_REUSABLE();
error L1_BLOB_REUSE_DISABLED();
error L1_INVALID_HOOK();
error L1_INVALID_PARAM();
error L1_INVALID_PROVER();
Expand Down Expand Up @@ -142,11 +142,11 @@ library LibProposing {
if (!_config.blobAllowedForDA) revert L1_BLOB_FOR_DA_DISABLED();

if (params.blobHash != 0) {
if (!_config.blobReuseEnabled) revert L1_BLOB_REUSE_DISALBED();
if (!_config.blobReuseEnabled) revert L1_BLOB_REUSE_DISABLED();

// We try to reuse an old blob
if (!isBlobReusable(_state, _config, params.blobHash)) {
revert L1_BLOB_NOT_REUSEABLE();
revert L1_BLOB_NOT_REUSABLE();
}
meta_.blobHash = params.blobHash;
} else {
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/contracts/L1/libs/LibUtils.sol
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ library LibUtils {
}

/// @dev Retrieves the ID of the transition with a given parentHash.
/// This function will return 0 if the transtion is not found.
/// This function will return 0 if the transition is not found.
function getTransitionId(
TaikoData.State storage _state,
TaikoData.Block storage _blk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ contract TestnetTierProvider is EssentialContract, ITierProvider {
function getMinTier(uint256 _rand) public pure override returns (uint16) {
// 10% will be selected to require SGX proofs.
if (_rand % 10 == 0) return LibTiers.TIER_SGX;
// Other blocks are optimisitc, without validity proofs.
// Other blocks are optimistic, without validity proofs.
return LibTiers.TIER_OPTIMISTIC;
}
}
2 changes: 1 addition & 1 deletion packages/protocol/contracts/L2/TaikoL2.sol
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ contract TaikoL2 is CrossChainOwned {
// gasExcess being 0 indicate the dynamic 1559 base fee is disabled.
if (gasExcess > 0) {
// We always add the gas used by parent block to the gas excess
// value as this has already happend
// value as this has already happened
uint256 excess = uint256(gasExcess) + _parentGasUsed;

// Calculate how much more gas to issue to offset gas excess.
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/contracts/bridge/Bridge.sol
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ contract Bridge is EssentialContract, IBridge {

/// @notice Ban or unban an address. A banned addresses will not be invoked upon
/// with message calls.
/// @param _addr The addreess to ban or unban.
/// @param _addr The address to ban or unban.
/// @param _ban True if ban, false if unban.
function banAddress(
address _addr,
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/contracts/tokenvault/BaseNFTVault.sol
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ abstract contract BaseNFTVault is BaseVault {
uint256 public constant MAX_TOKEN_PER_TXN = 10;

/// @notice Mapping to store bridged NFTs and their canonical counterparts.
mapping(address btoken => CanonicalNFT cannonical) public bridgedToCanonical;
mapping(address btoken => CanonicalNFT canonical) public bridgedToCanonical;

/// @notice Mapping to store canonical NFTs and their bridged counterparts.
mapping(uint256 chainId => mapping(address ctoken => address btoken)) public canonicalToBridged;
Expand Down
4 changes: 2 additions & 2 deletions packages/protocol/contracts/tokenvault/ERC20Vault.sol
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ contract ERC20Vault is BaseVault {
}

/// @notice Mappings from bridged tokens to their canonical tokens.
mapping(address btoken => CanonicalERC20 cannonical) public bridgedToCanonical;
mapping(address btoken => CanonicalERC20 canonical) public bridgedToCanonical;

/// @notice Mappings from canonical tokens to their bridged tokens. Also storing
/// the chainId for tokens across other chains aside from Ethereum.
Expand Down Expand Up @@ -341,7 +341,7 @@ contract ERC20Vault is BaseVault {
/// @return ctoken_ The canonical token.
/// @return balanceChange_ User token balance actual change after the token
/// transfer. This value is calculated so we do not assume token balance
/// change is the amount of token transfered away.
/// change is the amount of token transferred away.
function _handleMessage(
address _user,
address _token,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ contract USDCAdapter is BridgedERC20Base {

/// @notice Initializes the contract.
/// @param _owner The owner of this contract.
/// @param _adressManager The address of the {AddressManager} contract.
/// @param _addressManager The address of the {AddressManager} contract.
/// @param _usdc The USDC instance.
function init(address _owner, address _adressManager, IUSDC _usdc) external initializer {
__Essential_init(_owner, _adressManager);
function init(address _owner, address _addressManager, IUSDC _usdc) external initializer {
__Essential_init(_owner, _addressManager);
usdc = _usdc;
}

Expand Down
Loading