[Dev Tools] @matterlabs/hardhat-zksync-telemetry cannot be installed without devDependencies

[cprussin]

Team or Project

@matterlabs/hardhat-zksync-telemetry

ZK chain

N/A

Environment

Mainnet

Select the Dev Tool you are using

Hardhat Plugins

Provide the version of the tool (if applicable)

1.1.0

Provide a brief description of the functionality you're trying to implement and the issue you are running into.

Attempting to install @matterlabs/hardhat-zksync-telemetry without dev dependencies (e.g. using pnpm install --prod) will fail.

As a result, this package cannot be a dependency of anything that is attempting to e.g. build an optimized docker image for a service, etc.

The cause of this is that @matterlabs/hardhat-zksync-telemetry depends on the private package @matterlabs/zksync-telemetry-js, which appears to be an unpublished private package (it's not entirely clear why since the sources are distributed in the publicly available referenced tarball). Pulling the tarball referenced there and looking at the package.json, you'll see that it has a prepare script which runs husky, but husky is installed as a devDependency, meaning the prepare script fails and thus the install fails.

There are a few possible fixes:

1. Publish zksync-telemetry-js properly.
2. Remove the prepare script (maybe move it to some other lifecycle script or just expect devs to set up husky themselves, depending on your workflow)
3. Strip the prepare script out of the package.json when building the tarball (I'm not sure if the referenced tarball is just automatically generated from the git tree or if there's an actual build)

It honestly doesn't make a lot of sense for a published npm package to be referencing a publicly available tarball for a package which has full source code in the tarball and is not published to npm, so naiively it seems like #1 is by far the best option.

Repo Link (Optional)

No response

Additional Details

No response

[Romsters]

Hi @cprussin , thanks for reporting. For now it's fixed by removing prepare script. The git dependency is a temporary solution, it'll be properly switched to npm with the next release.

[vasyl-ivanchuk]

Make sure to use @matterlabs/hardhat-zksync-telemetry 1.1.1 or later for it to work.