DevMethodDoc doesn't accept custom natspec keys (@custom:oz-upgrades-*) :,(

[cryptoduels-team]

Environment in this moment

- rocketh/proxy: 0.19.15
- rocketh/deploy: 0.19.9
- rocketh/core: 0.19.4
- TypeScript: 6.0.3

Issue

The DevMethodDoc type in @rocketh/core/src/types.ts only accepts details, params, and returns. It doesn't allow custom natspec keys such as @Custom:oz-upgrades-unsafe-allow, which are required by OpenZeppelin for upgradeable contracts.
This causes a TS2322 error when using deployViaProxy with artifacts that include OpenZeppelin natspec:

tsdeployViaProxy({
  artifact,
  natspec: {
    '@custom:oz-upgrades-unsafe-allow': 'external-library-linking'
    // TS2322: Type '{ "@custom:oz-upgrades-unsafe-allow": string; }' 
    //   is not assignable to type 'DevMethodDoc'
  }
})

Current workaround

Casting the artifact to bypass type checking:

tsdeployViaProxy({
  artifact: { abi } as Artifact<typeof abi>
})

My proposal

Add an index signature to the DevMethodDoc type to accept @Custom:* keys:

tsexport type DevMethodDoc = {
    readonly details?: string;
    readonly params?: {readonly [name: string]: string};
    readonly returns?: {
        readonly [key: string | `_${number}`]: string;
    };
    readonly [key: `@custom:${string}`]: string;
};

OpenZeppelin requires custom:oz-upgrades-unsafe-allow in the constructor's natspec for upgradeable contracts. It's part of the standard and isn't optional. Any project using rocketh with OpenZeppelin UUPS runs into this issue.

[wighawag]

Thanks for the report, it is now fixed in: #47

published in latest release