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.

Sign up for GitHub

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

Refine Documentation and Code Comments for Improved Clarity #725

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Refine Documentation and Code Comments for Improved Clarity #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb37971
fix spelling errors in rollup.go
tomasandroil Feb 18, 2025
b7e598b
Fix typos README.md
tomasandroil Feb 18, 2025
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/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This package contains the smart contracts that compose the on-chain component.
| Name | Proxy Type | Description |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| [`L1CrossDomainMessenger`](../../specs/messengers.md) | [`ResolvedDelegateProxy`](./contracts/legacy/ResolvedDelegateProxy.sol) | High-level interface for sending messages to and receiving messages from M |
| [`L1StandardBridge`](../../specs/bridges.md) | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol) | Standardized system for transfering ERC20 tokens to/from Mo r p h |
| [`L1StandardBridge`](../../specs/bridges.md) | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol) | Standardized system for transferring ERC20 tokens to/from Mo r p h |
| [`Rollup`](../../specs/proposals.md#rollup.sol) | [`Proxy`](./contracts/universal/Proxy.sol) | Stores commitments to the state of Morph which can be used by contracts on L1 to access L2 state |
| [`MorphPortal`](../../specs/deposits.md#deposit-contract) | [`Proxy`](./contracts/universal/Proxy.sol) | Low-level message passing interface |
| [`MorphMintableERC20Factory`](../../specs/predeploys.md#morphmintableerc20factory) | [`Proxy`](./contracts/universal/Proxy.sol) | Deploys standard `MorphMintableERC20` tokens that are compatible with either `StandardBridge` |
Expand Down Expand Up @@ -79,7 +79,7 @@ yarn test

You must have [Echidna](https://github.com/crytic/echidna) installed.

Contracts targetted for Echidna testing are located in `./contracts/echidna`.
Contracts targeted for Echidna testing are located in `./contracts/echidna`.
Each target contract is tested with a separate yarn command, for example:

```shell
Expand Down
8 changes: 4 additions & 4 deletions tx-submitter/services/rollup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ func (r *Rollup) rollup() error {
}

// set batch cache
// it shoud be removed after the batch is committed
// it should be removed after the batch is committed
r.batchCache.Set(batchIndex, batch)

signature, err := r.buildSignatureInput(batch)
Expand Down Expand Up @@ -1345,7 +1345,7 @@ func (r *Rollup) InitFeeMetricsSum() error {
return fmt.Errorf("put rollupFeeSum to leveldb failed, key: %s, %w", rollupSumKey, err)
}
} else {
return fmt.Errorf("get data from leveldb faild, key: %s, %w", rollupSumKey, err)
return fmt.Errorf("get data from leveldb failed, key: %s, %w", rollupSumKey, err)
}
}
log.Info("rollupFeeSum: %f", rollupFeeSum)
Expand All @@ -1358,7 +1358,7 @@ func (r *Rollup) InitFeeMetricsSum() error {
return fmt.Errorf("put finalizeFeeSum to leveldb failed, key: %s, %w", finalizeSumKey, err)
}
} else {
return fmt.Errorf("get data from leveldb faild, key: %s, %w", finalizeSumKey, err)
return fmt.Errorf("get data from leveldb failed, key: %s, %w", finalizeSumKey, err)
}
}
log.Info("finalizeFeeSum: %f", finalizeFeeSum)
Expand All @@ -1371,7 +1371,7 @@ func (r *Rollup) InitFeeMetricsSum() error {
return fmt.Errorf("put collectedL1FeeSum to leveldb failed, key: %s, %w", collectedL1FeeSumKey, err)
}
} else {
return fmt.Errorf("get data from leveldb faild, key: %s, %w", collectedL1FeeSumKey, err)
return fmt.Errorf("get data from leveldb failed, key: %s, %w", collectedL1FeeSumKey, err)
}
}
r.collectedL1FeeSum = collectedL1FeeSum
Expand Down