feat: Support error / warning suppression in zksolc

[slowli]

• Allows to suppress zksolc errors and/or warnings by adding relevant fields to ZkSettings and passing them to standard JSON input for the compiler.

[elfedy]

Alternatively these fields could go on ZkSolcSettings vs here in order to remove duplicating the fields in both ZkSettings and ZkSolcInput (since one struct contains the other this may not be ideal). Then when building the input we pass them directly, we have this flow for CliSettings already

[slowli]

Could you explain how suppressed warnings / errors would be passed in this case? AFAIU, ZkSolcInput covers the entire standard JSON input for zksolc and zksolc requires these fields on the top level (not inside the settings object), so wouldn't it need to have these fields present in any case?

[elfedy]

They need to be in ZkSolcInput but not in ZkSettings neccesarily.

So there are a couple of structs involved in building the compilation input:

• ZkSolcSettings: which are the actual settings that are passed by foundry to the Project. This for now contains two fields
  • ZkSettings: which aims to be the literal settings object on JSON input.
  • CliSettings: which are cli arguments when compiling (e.g: base_path).
• ZkSolcVersionedInput : Which is built when resolving solc versions. This has all the information needed to compile.
• ZkSolcInput, the input actually passed as json

So lets say they are in ZkSolcSettings , when building the ZkSolcVersionedInput we would have:

impl CompilerInput for ZkSolcVersionedInput {
     type Settings = ZkSolcSettings;
     ...
    fn build(
        sources: Sources,
        settings: Self::Settings,
        language: Self::Language,
        version: Version,
    ) -> Self {

        let ZkSolcSettings { settings, cli_settings, suppressed_warnings, suppressed_errors } = settings;
        let input = ZkSolcInput { language, sources, settings, suppressed_warnings, suppressed_errors }.sanitized(&version);

        Self { solc_version: version, input, cli_settings }
    }
...
}

Hope that makes sense

[hedgar2017]

IIUC, I should not have put any new settings outside of the settings field.
Would it help if I deprecated them where they currently are and moved them inside settings?

[elfedy]

@hedgar2017 that does seem cleaner

[hedgar2017]

@elfedy please try this one!

[elfedy]

@slowli @hedgar2017 tested the new release here: b04a920 (Replace <PATH_TO_RELEASE> with the local path to zksolc test release). Seems to be working correctly (Tests pass with it and fail with previous releases)

[elfedy]

Maybe we can wait until those changes are part of a stable release then bump the version here and incorporate the changes in that test commit.

[hedgar2017]

@elfedy great!
We're going to make a release in the next few days.

[hedgar2017]

@elfedy released with zksolc v1.5.7!
Also supported by zksolc v1.5.6 and older, but one level above the settings object.

Change meant for future version