-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Typechain] generate types only for contracts and not test files #6400
base: v-next
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
"@nomicfoundation/hardhat-typechain": patch | ||
"hardhat": patch | ||
--- | ||
|
||
Replaced the hook for emitting compiled artifacts and updated its usage in the `hardhat-typechain` plugin. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -214,13 +214,6 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem { | |||||
); | ||||||
}), | ||||||
); | ||||||
|
||||||
await this.#hooks.runHandlerChain( | ||||||
"solidity", | ||||||
"onAllArtifactsEmitted", | ||||||
[contractArtifactsGeneratedByCompilationJob], | ||||||
async () => {}, | ||||||
); | ||||||
} | ||||||
|
||||||
const resultsMap: Map<string, FileBuildResult> = new Map(); | ||||||
|
@@ -651,6 +644,13 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem { | |||||
duplicatedContractNamesDeclarationFilePath, | ||||||
getDuplicatedContractNamesDeclarationFile(duplicatedNames), | ||||||
); | ||||||
|
||||||
await this.#hooks.runHandlerChain( | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Pato mentioned that probably this is the best place to add a hook that can emit the artifacts paths. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would mean we generate types only when the entire project is compiled - see
To be fair, I also find hooking types generation to the cleanup step a little confusing. It is not obvious to know what the type generation has to do with cleanup without deeply understanding the internals. I think there might be some potential for the refactor in the cleanup function, but that's definitely out of the scope of this PR. However, as far as when the type generation should get triggered, maybe it should be when the artifacts are emitted after all. But maybe we could add some option to the hardhat/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts Line 527 in 4554b50
|
||||||
"solidity", | ||||||
"onCleanUpArtifacts", | ||||||
[artifactPaths], | ||||||
async () => {}, | ||||||
); | ||||||
} | ||||||
|
||||||
public async compileBuildInfo( | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
import type { SolidityBuildSystem } from "../../../types/solidity/build-system.js"; | ||
import type { CompilationJob } from "../../../types/solidity.js"; | ||
|
||
import "../../../types/config.js"; | ||
declare module "../../../types/config.js" { | ||
|
@@ -99,19 +98,20 @@ declare module "../../../types/hooks.js" { | |
|
||
export interface SolidityHooks { | ||
/** | ||
* Provide a handler for this hook to retrieve all artifacts created by a compilation job. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The old hook can be removed in favor of the new one. See previous comment for more details |
||
* Hook triggered during the cleanup process of Solidity compilation artifacts. | ||
* This hook runs after unused artifacts and build-info files have been removed. | ||
* | ||
* @param context The hook context. | ||
* @param artifacts A map of the artifacts created by each compilation job. | ||
* @param artifactPaths The file paths of artifacts that remain after cleanup. | ||
* @param next A function to call the next handler for this hook, or the | ||
* default implementation if there are no more handlers. | ||
* default implementation if no more handlers exist. | ||
*/ | ||
onAllArtifactsEmitted: ( | ||
onCleanUpArtifacts: ( | ||
context: HookContext, | ||
artifacts: Map<CompilationJob, ReadonlyMap<string, string[]>>, | ||
artifactPaths: string[], | ||
next: ( | ||
nextContext: HookContext, | ||
artifacts: Map<CompilationJob, ReadonlyMap<string, string[]>>, | ||
artifactPaths: string[], | ||
) => Promise<void>, | ||
) => Promise<void>; | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need a double check on this changeset, is this format acceptable for the
v-next
?