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

General Revision + improvements #55

Open
MBerguer opened this issue Dec 26, 2024 · 0 comments
Open

General Revision + improvements #55

MBerguer opened this issue Dec 26, 2024 · 0 comments
Assignees

Comments

@MBerguer
Copy link

MBerguer commented Dec 26, 2024

I did a general overview of the current state of the book and saw that there are a few sections we could improve quickly and others that need more work.


Here is a summary of what I would change in each section:

1. Installation

  • Fix links and typos.

Projects

4. Working on an Existing Project

  • Rephrase for clarity.

8. Project Layout

  • Nit: The readme file is missing

ZKsync Specifics

9. Overview

  • Introductory comment

10. Execution Overview

  • Introduce about “Execution overview”
  • Add links for cheatcodes + solc
  • Improve more why that happens.

11. Compilation Overview

  • Add an example.

12. Configuration Overview

  • Fix 404

13. Limitations

  • General Introduction

13.1. General

  1. Reserved Address Range
    — divide testFoo into two, one for each.
    — Add links to other sections
    — Rephrase sentence for clarity

  2. Address Derivation
    — Rephrase why “limitation”

  3. Accessing Contract Bytecode and Hash
    — Expand about why CREATE2 here.

13.2. Compilation

13.1. Contract or Bytecode Access
— add a link to EXTCODECOPY

15. Additional Cheatcodes

  • General review: there is one missing (zkUseFactoryDep). Review if others

Gas overview:

General fixes / Other comments:

  • Rename testFoo to something more meaningful (multiple places)
  • Format code consistently (commands, directives, etc. should be like this to improve reading)
  • Add a new section with common errors. (An alternative could be to modify the tests, so they assert for potential failure reasons, 13.1 13.2 13.6)

There might be more things to cover (🧵); this is just a start, as we want to make the book more stable and closer to the actual codebase in https://github.com/matter-labs/foundry-zksync

@MBerguer MBerguer self-assigned this Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant