Wrong `OpaquePeerId` imported in TypeScript augmentation

[gdethier]

• I'm submitting a ...

  • [x] Bug report
  • [ ] Feature request
  • [ ] Support request
  • [ ] Other

• What is the current behavior and expected behavior?

When generating custom typescript definitions for a custom Substrate node using the nodeAuthorization pallet in its runtime, there seems to be a kind of "clash" between nodeAuthorization's OpaquePeerId and imOnline's one. In order to prevent some double-encoding issue, we had to override (in definitions.ts file) OpaquePeerId so that it is defined as a Vec<u8> (and not a WrapperOpaque<Bytes> like in imOnline). This works in our case because we are not using the imOnline pallet.

However, even when overriding the type definition, imOnline's type keeps to be imported in the augment-*.ts files. The only workaround we have found so far is to fix the imports manually i.e. rewrite imports like

import type { OpaquePeerId } from '@polkadot/types/interfaces/imOnline';

into

import type { OpaquePeerId } from './default';

In order to reproduce:

• Build logion Substrate node (commit in link) and run it
• Clone logion-api (commit in link)
• Go to package packages/node-api
• Generate type defs: yarn generate:defs-meta

You'll see that all OpaquePeerId are reset to point to imOnline's OpaquePeerId.

• What is the motivation for changing the behavior?

When a type is explicitly overridden in a definitions file, it should also be imported in the augment files.

• Please tell us about your environment:

  • Version: @polkadot/typegen 8.14.1

  • Environment:

  • [x] Node.js

  • [ ] Browser

  • [ ] Other (limited support for other environments)

  • Language:

  • [ ] JavaScript

  • [x] TypeScript 4.7.4

  • [ ] Other

[jacogr]

I believe the network layer ios actually problematic here, encoding things twice. Just looking at the use, it is meant to be Bytes (as per Rust), not Opaque<Bytes>, which makes the imOnline work, but is not really correct based on the Rust types.

So we probably need a specific override for the imOnline pallet to make the specific use there work. (And revert the type definition to match with Rust for the more general "available everywhere" case)