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 natspec for IContractDeployer #517

Open
PatrickAlphaC opened this issue Jun 8, 2024 · 0 comments
Open

Update natspec for IContractDeployer #517

PatrickAlphaC opened this issue Jun 8, 2024 · 0 comments

Comments

@PatrickAlphaC
Copy link

🌟 Feature Request

Reading the IContractDeployer interface, it's not clear what the parameters of each function do especially for important functions such as the create and create2 functions.

📝 Description

Please add @param natspec annotations for what each of the parameters do.

🤔 Rationale

Deploying contracts is different on zkSync than on Ethereum. Because of that, when users dig deep into what's going on under the hood, it should be very clear what's going on. Right now, attempting to "peek under the hood" will be met with disappointment and more confusion.

  • What is input?
  • What is bytehash?
    etc
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