Skip to content

Update natspec for IContractDeployerΒ #517

@PatrickAlphaC

Description

@PatrickAlphaC

🌟 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions