From 84c4fc25a42dfa0d3c56a17cc55b1ebdfe7a249b Mon Sep 17 00:00:00 2001 From: rahul Date: Thu, 4 Apr 2024 18:35:32 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9E=20fix(Spell=20check):=20Spell=20ch?= =?UTF-8?q?eck=20CI=20-=20false=20positives?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/PULL_REQUEST_TEMPLATE.md | 8 +++-- .github/workflows/spell-check.yml | 15 +++++++-- docs/eps/week7-research.md | 2 +- docs/wiki/protocol/history.md | 2 +- notes/steven_notes/weekly_updates_1.md | 24 +++++++------- wordlist.txt | 44 ++++---------------------- 6 files changed, 40 insertions(+), 55 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f2c8205b..5e9d9a65 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,11 +12,15 @@ Thank you for contributing to the Protocol Wiki! Before you open a PR, make sure 1. Install [aspell](https://www.gnu.org/software/aspell/) for your platform. 2. Navigate to the project root and run: ``` - for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true list < $f | sort | uniq -c ; done + for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list < $f | sort | uniq -c ; done ``` ℹ️ Fixing typos 1. Fix typos: Open the relevant files and fix any identified typos. 2. Update wordlist: If a flagged word is actually a project-specific term add it to `wordlist.txt` in the project root. - Each word should be listed on a separate line and must not have any spaces or special characters before or after it. + Each word should be listed on a separate line. + * 🚧 Remember: + * When adding new words it must NOT have any spaces or special characters within or around it. + * \`wordlist\` is NOT case sensitive. + * Use backticks to quote code variables so as to not bloat the \`wordlist\`. --> diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 2f6650b4..5d1153c9 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -30,8 +30,15 @@ jobs: run: | echo "Checking for typos..." for file in $(find . -name "*.md" ); do - output="$(aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true list <$file | sed 's/^/ 1. /')" + output="$(aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list <$file)" + echo "$output" + # Exit if aspell has errors + if [ $? -ne 0 ]; then + exit 1 + fi if [[ -n "$output" ]]; then + # Format output. + output=$(echo "$output" | sed 's/^/ 1. /') TYPOS+="- 📄 $file:" TYPOS+=$'\n' TYPOS+="$output" @@ -62,7 +69,11 @@ jobs: ## ℹ️ Here's how to fix them: - **Fix typos:** Open the relevant files and fix any identified typos. - **Update wordlist:** If a flagged word is actually a project-specific term add it to \`wordlist.txt\` in the project root. - Each word should be listed on a separate line and must not have any spaces or special characters before or after it. [Learn more.](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html) + Each word should be listed on a separate line. [Learn more.](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html) + - **🚧 Remember:** + - When adding new words it MUST NOT have any spaces or special characters within or around it. + - \`wordlist\` is NOT case sensitive. + - Use backticks to quote code variables so as to not bloat the \`wordlist\`. `; github.issues.createComment({ diff --git a/docs/eps/week7-research.md b/docs/eps/week7-research.md index 57d1646e..ec5e6443 100644 --- a/docs/eps/week7-research.md +++ b/docs/eps/week7-research.md @@ -20,7 +20,7 @@ Additionally, you can read and get ready by studying the following resources: - MPT and the Verge - Design and cryptography - Transitioning the state tree to verkle -- Current state and challanges +- Current state and challenges ## Additional reading and exercises diff --git a/docs/wiki/protocol/history.md b/docs/wiki/protocol/history.md index 9856a54a..6c2d0487 100644 --- a/docs/wiki/protocol/history.md +++ b/docs/wiki/protocol/history.md @@ -2,7 +2,7 @@ This page highlights important technical changes in the history of Ethereum protocol. -Usefull links: [Overview from Ethereum.org](https://ethereum.org/en/history) and [Meta EIPs from Ethereum.org](https://eips.ethereum.org/meta) +Useful links: [Overview from Ethereum.org](https://ethereum.org/en/history) and [Meta EIPs from Ethereum.org](https://eips.ethereum.org/meta) ## Homestead diff --git a/notes/steven_notes/weekly_updates_1.md b/notes/steven_notes/weekly_updates_1.md index 17c7c214..065f10e1 100644 --- a/notes/steven_notes/weekly_updates_1.md +++ b/notes/steven_notes/weekly_updates_1.md @@ -26,23 +26,23 @@ The primary resource I utilized this week was the [Eth2 Book on Consensus Prelim A particularly helpful resource was the blog [Engine API: A Visual Guide](https://hackmd.io/@danielrachi/engine_api#Block-Building). I explore the Prysm codebase with this blog and below are some annotated insights into the source code: -- **prycm client initialization flow: prysm/cmd/beacon-chain/main.go** +- **prysm client initialization flow: prysm/cmd/beacon-chain/main.go** 1. app.New() // cli application/instance 2. parseFlags - 3. app.before(ctx) - 4. app.Action(ctx) + 3. `app.before(ctx)` + 4. `app.Action(ctx)` - node.New() // register every required services - - startNode(ctx, cancel) + - `startNode(ctx, cancel)` - beacon, err := node.New(...) // beacon node handles the lifecycle of entire system - beacon.Start() - beacon.services.StartAll() // initialized each service in order of registration - p2p - - initialsync + - initialSync - backfill - attestations - blockchain - ... - 5. app.After(ctx) + 5. `app.After(ctx)` - **engine api interface: /prysm/beacon-chain/execution/engine_client.go** ``` @@ -58,8 +58,8 @@ type EngineCaller interface { ``` - **validator lifetime** - 1. receive block from other validators: **/prysm/beacon-chain/blockcain/receive_block.go** - 1. extract excution payload + 1. receive block from other validators: **/prysm/beacon-chain/blockchain/receive_block.go** + 1. extract execution payload 2. **s.validateExecutionOnBlock**: call engine_newPayload 3. **s.postBlockProcess**: call engine_engine_forkchoiceUpdated 2. propose block: **/prysm/beacon-chain/rpc/prysm/v1alpha1/validator/proposer.go** @@ -71,21 +71,21 @@ type EngineCaller interface { **RoadMap** For reference: [Ethereum Roadmap](https://ethereum.org/en/roadmap/) -The roadmap aims at bringing four benifits for users: +The roadmap aims at bringing four benefits for users: - Cheaper transactions(Done partially) - Proto-Danksharding (Done recently in EIP-4844) - Danksharding - - Dencentralizing rollups + - Decentralizing rollups - Extra security (need to finalize a specification and start building prototypes) - Single slot finality - DVT - - Proposer-builder sepration + - Proposer-builder separation - Secret leader election - Better user experience - Account abstraction(EIP-4337) - Nodes for everyone - Verkle tree - - Statelessness(weak statelessness preferred but rely on Verkle tree and Proposer-builder sepration) + - Statelessness(weak statelessness preferred but rely on Verkle tree and Proposer-builder separation) - Data expiry(portal network is an option) - Future proofing (still in the research phase) - Quantum resistance diff --git a/wordlist.txt b/wordlist.txt index 58b0a19f..09156c90 100644 --- a/wordlist.txt +++ b/wordlist.txt @@ -4,7 +4,6 @@ ABI accelerometer ACD allowfullscreen -AltExplainer Andreas Antonopoulos API @@ -16,7 +15,7 @@ Assertoor autoplay Bankless Barnabe -baseFeePerGas +backfill Beiko Bertoni BFT @@ -26,7 +25,6 @@ BLOBHASH blockchain blockchain's blockchains -blockNumber blockquotes blocksize BLS @@ -47,10 +45,10 @@ CoC codebase codebases CODECOPY -CollectDrink config congestions Corbellini +cmd Crypto cryptocurrencies cryptocurrency @@ -90,6 +88,7 @@ Domothy Dragan Driscoll DSA +DVT EB ECADD ECC @@ -132,8 +131,6 @@ evmlab EVMONE excalidraw exchangeTransitionConfigurationV -execPayload -ExecutionPayload Explainer Feist Femboy @@ -154,31 +151,15 @@ Gasper gasPrice gasUsed Georgios -getBadBlocks -getBalance -GetBlockBodies -getBlockByHash -getBlockByNumber -GetBlockHeader -getBlockTransactionCountByHash -getBlockTransactionCountByNumber -getCode geth -getLogs getPayloadBodiesByHashV getPayloadV -GetPooledTransactions -getRawBlock -getRawHeader -getRawReceipts -getRawTransactions -GetReceipts -getStorageAt getters Gilles Goron gpg Grafana +Guillaume hoc Holesky Hsiao @@ -186,6 +167,7 @@ ics iframe ify impera +implementers incentivize inevitableeth infrastracture @@ -211,9 +193,9 @@ KZG KZGCommitment KZGProof Lamport -LeftAsExercise Lefteris libp +lifecycle Lightclient Lightclient's liveness @@ -227,8 +209,6 @@ LuaVM mainnet Mário mathbb -maxFeePerGas -maxPriorityFeePerGas mem Mempool Menezes @@ -252,9 +232,7 @@ namespace namespaces Nand natively -newPayload newPayloadV -NewPooledTransactionHashes NFT NIST NOXX @@ -286,12 +264,9 @@ precompiled precompiles privateKey programmability -Proof-of-stake -proof-of-stake -Proof-of-work -proof-of-work proto PRs +Prysm PUSHX py Pyspec @@ -321,7 +296,6 @@ schemas Schocken SECG secp -SelectDrink SELFDESTRUCT sexualized SHA @@ -351,7 +325,6 @@ StreamEth systemd Takenobu Tani -TestingTheMerge testnet Tetris textnormal @@ -376,10 +349,8 @@ validator validators Vanstone VDFs -VerifyHeaders Verkle verkled -VersionedHash Victorio Vitalik VM @@ -387,7 +358,6 @@ Vyper walkthrough webkit WebRTC -WebSockets Whitepaper WIP WSS