TypeScript project fails to build; module 'web3/providers' not found

[hrharder]

As of a few days ago, a TypeScript project I am working on suddenly started failing, reporting an issue originating from node_modules/ganache-core/typings/index.d.ts (see full error below).

The issue appears to be the typings/index.d.ts file imports some types from package web3/providers, which really should just be web. This PR addresses that. I was able to confirm the change solves my problem

Expected Behavior

The project should build with no error.

Current Behavior

The project fails to build with tsc with the following error:

$ tsc
node_modules/ganache-core/typings/index.d.ts:2:44 - error TS2307: Cannot find module 'web3/providers'.

2   import { Provider as Web3Provider } from "web3/providers";
                                             ~~~~~~~~~~~~~~~~
Found 1 error.

Possible Solution

Before

// from typings/index.d.ts

declare module "ganache-core" {
  import { Provider as Web3Provider } from "web3/providers";

  namespace Ganache {
    export interface IProviderOptions {
// ...

After

// from typings/index.d.ts

declare module "ganache-core" {
  import { Provider as Web3Provider } from "web3";

  namespace Ganache {
    export interface IProviderOptions {
// ...

Steps to Reproduce (for bugs)

1. Clone this project.
2. Run yarn to install dependencies (of which ganache-core is one)
3. Run yarn build to build the TypeScript source
4. See the error above

Context

Our project fails to build locally and in CI environments, prohibiting us from continuing to integrate changes into our codebase.

Your Environment

• Version used: 2.7.0
• Environment name and version:
  • Node.js LTS (10.15.3)
  • TypeScript (3.5.3)
  • Yarn (1.17.3)
• Operating System and version:
  • MacOS (darwin)
  • Linux
• Link to your project:
  • Private project
  • This project isolates the issue.

[hrharder]

Alright I have found a solution. It appears these types refer to @types/web3 rather than the types provided by the web3 package.

I will close this issue, but I would suggest making the change I suggested, and removing the dependency on @types/web3, now that the web3 package includes TypeScript types by default.

[alcuadrado]

Hey @davidmurdoch

This issue reappeared with the latest release of web3, as it now has TS types again. web3's built-in types win over @types/web3, and they don't have a providers module.

This is preventing me from compiling one of my projects, and I couldn't find a workaround so far. I think I could delete typings/index.d.ts in a post-install script, but that would only work for me, and not my users.

[bigspider]

Hi, is there any update on this issue? I'm having this problem as well.

[fabioberger]

Bump on this.

[alcuadrado]

Hey @davidmurdoch @gnidan

I bumped into this issue once again, but this time I can't find a way to workaround it.

Have you considered just removing types from the package.json? TBH I think web3 should also do the same.

I know that removing the types can sound like a drastic measure, but I'm not sure who is actually using these typings, as they are broken. The only way to use ganache-core from a TS project is with require("ganache-core"), which ignores them. But you can't control if your dependencies use import or require.

I wouldn't delete the typings folder though, so if someone really wants to use those typings, they can do it by adding them to their tsconfig.json's files.

Thanks!

[alcuadrado]

I'm not sure who is actually using these typings, as they are broken

I just realized that they are only broken if you also have a web3 installation. So maybe that's why not everyone is complaining about this.

[alcuadrado]

Update: I found a workaround. If I don't install web3 and install @types/web3@1.0.19 I can compile my project.

@fabioberger this may help you