The CompilerOutputContract type doesn't include fields for optional outputs

[kalote]

Version of Hardhat

2.13.0

What happened?

Hello!

I'm trying to get the storageLayout information from the buildInfo. I'm using hardhat in typescript. I changed my hardhat.config.ts with this:

const config: HardhatUserConfig = {
  solidity: {
    version: '0.8.17',
    settings: {
      optimizer: {
        enabled: true,
        runs: 1000,
      },
      outputSelection: {
        '*': {
          '*': ['storageLayout'],
        },
      },
    },
  },
};

But i end up with a TS issue when trying to access the storageLayout property:

(await artifacts.getBuildInfo('contracts/CustomToken.sol:CustomToken'))?.output.contracts['contracts/CustomToken.sol'].CustomToken.storageLayout

Property 'storageLayout' does not exist on type 'CompilerOutputContract'.ts(2339)

Any idea?
Thank you!

Minimal reproduction steps

• Create a TS hardhat project
• Add the custom compiler options:

const config: HardhatUserConfig = {
  solidity: {
    version: '0.8.17',
    settings: {
      optimizer: {
        enabled: true,
        runs: 1000,
      },
      outputSelection: {
        '*': {
          '*': ['storageLayout'],
        },
      },
    },
  },
};

• Create a basic contract
• Try to access the storageLayout using

(await artifacts.getBuildInfo('contracts/CustomToken.sol:CustomToken'))?.output.contracts['contracts/CustomToken.sol'].CustomToken.storageLayout

Search terms

storage layout output selection

[kalote]

Any news?

[fvictorio]

Hey @kalote, sorry for not responding sooner.

Sadly the only workaround here is to cast (await artifacts.getBuildInfo('contracts/CustomToken.sol:CustomToken'))?.output.contracts['contracts/CustomToken.sol'].CustomToken to any (or to an expanded type that includes storageLayout).

As a long term solution, we should use a better type for CompilerOutputContract, which includes other things as optional properties, since they could be added by the user, like in your case.