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

Update morth-doc: fix typos #49

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion docs/build-on-morph/build-on-morph/2-development-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ https://holesky-faucet.pk910.de/

https://cloud.google.com/application/web3/faucet/ethereum (needs a Google account)

We have our own [website faucet](https://morphfaucet.com/) that can claim ETH & USDT for you initial usage.
We have our own [website faucet](https://morphfaucet.com/) that can claim ETH & USDT for your initial usage.


Morph also offers a [Discord faucet](../../quick-start/3-faucet.md#morph-holesky-eth) to obtain Morph Holesky USDT & Morph Holesky ETH.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The easiest way to support your token is to manually add it on our [official bri

### Add token support to the bridge frontend

By adding your token to the gateway, you and other users can bridge the token by inputting the token address.You need to raise a PR to our bridge repo if you want your token shown on the bridge frontend token list.
By adding your token to the gateway, you and other users can bridge the token by inputting the token address. You need to raise a PR to our bridge repo if you want your token shown on the bridge frontend token list.

You can find how to do it in the [morph list repo](https://github.com/morph-l2/morph-list).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ forge flatten --output FlattenedL2StandardBridge.sol ./contracts/L2/L2StandardBr
#### Obtain JSON File

- Can be obtained through solc
- Can be obatined through remix compiler
- Can be obtained through remix compiler

![sjis2](../../../assets/docs/dev/contract-verify/sjisol3.png)

Expand All @@ -94,7 +94,7 @@ forge flatten --output FlattenedL2StandardBridge.sol ./contracts/L2/L2StandardBr

#### Frontend:

- You can submit multiple contract file by your own needs
- You can submit multiple contract files by your own needs
![mpfs1](../../../assets/docs/dev/contract-verify/mpfsol.png)

#### SOL File Process
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ curl -L https://foundry.paradigm.xyz | bash
foundryup
```

Then go the right folder of our example:
Then go to the right folder of our example:

```bash
cd contract-deployment-demos/foundry-demo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,11 +291,11 @@ Object - RollupBatch
1. version: quantity - the version of the batch
2. hash: DATA: 32 bytes - the batch of this batch
3. parentBatchHeader: bytes - the parent batch header
4. Chunks: arrays of chunk - Chunk: bytes : the chunk bytes of this batch
4. Chunks: arrays of chunk - Chunk: bytes: the chunk bytes of this batch
5. skippedL1MessageBitmap: bytes - the bitmap of the skipped L1Message
6. prevStateRoot: DATA: 32 bytes - the state root at the beginning of this batch
7. postStateRoot: DATA: 32 bytes - the state root at the end of this batch
8. withdrawRoot: DATA : 32 bytes - the withdraw root at the end of this batch
8. withdrawRoot: DATA: 32 bytes - the withdraw root at the end of this batch
9. sidecar - the side car for the rollup transaction of the blob type
10. signatures - array of object of signature:

Expand Down Expand Up @@ -517,4 +517,4 @@ It replays the block and returns the structured blockTrace for rollers.
"startL1QueueIndex": 0
}
}
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ This guide outlines the steps to start a Morph node. The example assumes the hom

Running the morph node requires 2 processes: `geth` and `node`.

- `Geth`:the Morph execution layer which needs to meet the requirements as below
- `Geth`: the Morph execution layer which needs to meet the requirements as below
- Fast CPU with 4+ cores
- 32GB+ RAM
- High-performance SSD with at least 1TB of free space
- 25+ MBit/sec download Internet service


- `Node`:the Morph consensus layer embedded tendermint which needs to meet the [tendermint hardware requirements](https://docs.tendermint.com/v0.34/tendermint-core/running-in-production.html#processor-and-memory).
- `Node`: the Morph consensus layer embedded tendermint which needs to meet the [tendermint hardware requirements](https://docs.tendermint.com/v0.34/tendermint-core/running-in-production.html#processor-and-memory).


:::tip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ make run-holesky-node
Running this command will create a `.morph-holesky` directory in your user directory by default, serving as the node's home directory. Before starting the node, this command will perform several preparations:

- Create the node's home directory and copy the default configuration files into it.
- Prepare the `secret-jwt.txt` file for for authentication during RPC calls between geth and the node.
- Prepare the `secret-jwt.txt` file for authentication during RPC calls between geth and the node.
- Download the latest snapshot data to speed up node synchronization.
- Place the extracted snapshot data into the corresponding folder within the home directory.

Expand All @@ -55,7 +55,7 @@ The host directory paths that are mounted by the Docker container are specified
NODE_HOME=${HOME}/.morph-holesky
// the data directory for your execution client: geth
GETH_DATA_DIR=${NODE_HOME}/geth-data
// the data directory for you consensus client: tendermint
// the data directory for your consensus client: tendermint
NODE_DATA_DIR=${NODE_HOME}/node-data
// the entrypoint shell script for start execution client
GETH_ENTRYPOINT_FILE=${NODE_HOME}/entrypoint-geth.sh
Expand Down Expand Up @@ -92,4 +92,4 @@ You may also manually manage snapshot, particularly if you are using custom path
The **make download-and-decompress-snapshot** command in the ```ops/publicnode``` directory will assist you in downloading and decompressing the snapshot archive.

Then, you need to manually place the decompressed data files in the appropriate node data directories.
For example, if the snapshot folder is named ```snapshot-20240805-1```, move the contents from ```snapshot-20240805-1/geth``` to the ```${GETH_DATA_DIR}/geth``` directory and the contents from ```snapshot-20240805-1/data``` to the ```${NODE_DATA_DIR}/data``` directory.
For example, if the snapshot folder is named ```snapshot-20240805-1```, move the contents from ```snapshot-20240805-1/geth``` to the ```${GETH_DATA_DIR}/geth``` directory and the contents from ```snapshot-20240805-1/data``` to the ```${NODE_DATA_DIR}/data``` directory.
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ git checkout ${latestVersion}
cd ops/publicnode
make stop-holesky-node
make rm-holesky-node
## delete the pervious docker image for node
## delete the previous docker image for node
docker rmi morph/node:latest
## delete the pervious docker image for geth
## delete the previous docker image for geth
docker rmi morph/geth-nccc:latest
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ eOracle is currently in the progress of integrating Morph mainnet.

Deployed Morph Holesky testnet [contract](https://explorer-holesky.morphl2.io/address/0xbd53b35Bf458Cd22dBDeB5Da71181daA3cFb6A10)

Full price feeds and docs can be found here : https://eoracle.gitbook.io/eoracle/price-feeds/feed-addresses.
Full price feeds and docs can be found here: https://eoracle.gitbook.io/eoracle/price-feeds/feed-addresses.
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The following is a simple illustration of Morph’s decentralized sequencing net

A complete Morph decentralized sequencer network consists of two parts:

- **Sequencer Set** : This forms the core group that provides sequencing services
- **Sequencer Set**: This forms the core group that provides sequencing services
- **Sequencer Staking Contract**: This contract facilitates the selection of the sequencer set via an election process.

Through the sequencer staking contract, members are elected into the sequencer set, where they collaboratively provide services for the Morph network. Periodically, the election results are synchronized to the Layer 1 Rollup contract. This synchronized data is utilized to obtain the BLS aggregate signatures of sequencer network participants for comparison and verification.
Expand Down
16 changes: 8 additions & 8 deletions docs/how-morph-works/general-protocol-design/1-rollup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ The batch submitter then reconstructs L2 blocks, compiling:


- Transactions: All transactions contained within the blocks.
- Blockinfo : Essential information from each block.
- Blockinfo: Essential information from each block.


The batch submitter continues fetching and reconstructing blocks until it processes a block with a BLS signature, indicating the batch point has been reached. The reconstructed block data is used to construct a batch, which contains:

- lastBlocknumber : The number of the final block in the batch.
- Transactions : Encoded transactions within the batch.
- BlockWitness : Encoded blockinfos, utilized for zkProof.
- PreStateRoot : The stateRoot before the batch is applied.
- PostStateRoot : The stateRoot after the batch is applied.
- WithdrawalRoot : L2 withdrawal Merkle tree root.
- Signature : The batch’s BLS signature.
- lastBlocknumber: The number of the final block in the batch.
- Transactions: Encoded transactions within the batch.
- BlockWitness: Encoded blockinfos, utilized for zkProof.
- PreStateRoot: The stateRoot before the batch is applied.
- PostStateRoot: The stateRoot after the batch is applied.
- WithdrawalRoot: L2 withdrawal Merkle tree root.
- Signature: The batch’s BLS signature.


:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start/3-faucet.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Morph Holesky USDT address: "0x9E12AD42c4E4d2acFBADE01a96446e48e6764B98"

~~~

7. Check you wallet for USDT balance and start to bridge!
7. Check your wallet for USDT balance and start to bridge!



Expand Down