add Hardhat 3 plugin docs section#27
Draft
roeezolantz wants to merge 1 commit into
Draft
Conversation
@cofhe/hardhat-3-plugin was published in 0.5.0 but the docs only cover the v2 plugin. Add a parallel 'Hardhat 3 Plugin' nav group with five pages matching the v2 layout (getting-started, client, mock-contracts, logging, testing), adapted to the Hardhat 3 plugin/hook model: network.connect() lifecycle, conn.cofhe namespace alongside conn.viem, node:test 'async describe' pattern, Viem contract descriptors instead of typed ethers contracts. Co-authored-by: multica-agent <github@multica.ai>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@cofhe/hardhat-3-pluginwas published in0.5.0but `docs.json` has no entries for it — the Client SDK tab only documents the Hardhat v2 plugin. Adds a parallel "Hardhat 3 Plugin" nav group with the same 5-page layout, adapted to the Hardhat 3 plugin/hook model.This covers gap B-5 from the docs audit on XDL-11.
Where the underlying change was made
@cofhe/hardhat-3-plugin@0.5.0— cofhesdk CHANGELOG0.5.0— `f78beb7`. Direct quote: "@cofhe/hardhat-3-plugin— Hardhat 3 plugin with the same mock contract deployment,network.cofheAPI, logging, and faucet task as the v2 plugin, adapted to the Hardhat 3 plugin/hook model."hre.solidity.build()during thehre.createdhook to compile mock contracts once at startup, enabling the EDR to decode their custom errors by name.deployFixedanddeployVariablenow source bytecode fromhre.artifacts.readArtifact()."mocksDeployVerbosityconfig option (same'' | 'v' | 'vv'values as the v2 plugin) — cofhesdk CHANGELOG0.5.0.Changes
client-sdk/hardhat-3-plugin/getting-started.mdxcofheconfig block (with the same three options as v2), how auto-deployment hooksnetwork.connect(), table of mock contracts and addresses, a "Differences from@cofhe/hardhat-plugin" table highlighting the v2 → v3 plumbing changes.client-sdk/hardhat-3-plugin/client.mdxcofhe.createConfig,cofhe.createClient,cofhe.createClientWithBatteries— same three-tier shape as the v2 client page, adapted toconn.cofhe.*instead ofhre.cofhe.*.client-sdk/hardhat-3-plugin/mock-contracts.mdx{ address, abi }contract descriptors (cofhe.mocks.MockTaskManageretc.),getPlaintext/expectPlaintext(acceptbigintor hex string),deployMocksfor mid-test resets.client-sdk/hardhat-3-plugin/logging.mdxwithLogs(name, fn),enableLogs(),disableLogs(), plus the gate thatcofhe.logMocks: falseoverrides the runtime toggles.client-sdk/hardhat-3-plugin/testing.mdxcreateClientWithBatteries,expectPlaintext, direct descriptor calls, scopedwithLogs), and a "Common pitfalls" accordion mirroring the v2 testing page.docs.jsonThe new pages follow the same Mintlify structure as the v2 plugin pages (intro paragraph →
<Note>cross-link → "What the plugin provides" → install<Steps>→ config table → API reference → "Common pitfalls"<AccordionGroup>on the testing page).Test plan
/client-sdk/hardhat-plugin/getting-started,/client-sdk/hardhat-plugin/testing) resolve.