fix: mismatched ethers types when in esm project

[pauldesmondparker]

Fix mismatch of ethers/lib.commonjs Provider with ethers/lib.esm Provider. This has been an issue when attempting to construct configuration driven provider fallbacks for did-resolver

Drilling down to the Provider type via this package within an esm package yielded a lib.commonjs Provider that did not match the esm ethers Provider.

Restructure build directories into lib.commonjs and lib.esm. Matches structure in ethers.js

Adjust .gitignore to exclude new out directories

Separated into two tsconfig files named tsconfig.{common,esm}.json

[package.json]
Removed source [not in spec]
Removed type, module, and types from top level Added import and require to exports and re-added types Modified files to point to new out dirs, removed LICENSE (included by default), and src (no utility).
Modified script clean
Added new build: scripts both called from build

[pauldesmondparker]

This might seem like a non-issue without some context. We're pulling two types, one from ethers the other from ethr-did-resolver to let us build a FallbackProvider from a configuration list. The types: FallbackProviderConfig and ProviderConfiguration.

type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
type FuncGetResolver = typeof ethrDidResolver;
type FuncParameter = ArgumentsType<FuncGetResolver>[0];
interface InfuraConfiguration {
  infuraProjectId: string;
}
type MultiProviderConfiguration = Exclude<FuncParameter, InfuraConfiguration>;
type ProviderConfiguration = Exclude<
  MultiProviderConfiguration['networks'],
  undefined
>[number];

type ProviderOrConfig = ConstructorParameters<
  typeof FallbackProvider
>[0][number];

type FallbackProviderConfig = ProviderOrConfig extends AbstractProvider
  ? never
  : ProviderOrConfig;

However, at the end of this process the Provider type in each is different because ethr-did-resolver uses a require pathway to pull in its ethers.js dependency. This resulted in the following mismatch:

...ethers/lib.esm/providers/network").Network> is not assignable to type
...ethers/lib.commonjs/providers/network").Network>

[pauldesmondparker]

For ease of testing, use the branch #publish on my repo.

Warning

Only pnpm has been tested by me.

With package.json and pnpm:

  "pnpm": {
    "overrides": {
      "ethr-did-resolver": "pauldesmondparker/ethr-did-resolver#publish"
    }
  },

npm:

  "overrides": {
    "ethr-did-resolver": "github:pauldesmondparker/ethr-did-resolver#publish"
  }

yarn:

  "resolutions": {
    "ethr-did-resolver": "https://github.com/pauldesmondparker/ethr-did-resolver#publish"
  }

[pauldesmondparker]

Fixed test. Forgot to specify a tsconfig file in Jest config.

Locally I get a warning about linking for Ganache, but it's likely the version of node I used: lts/iron.

Also ran format and lint.

[pauldesmondparker]

Using lts/hydrogen (same as ci), gives the same linking failure locally:

Note

Tests are passing though.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.