OpenZeppelin / OpenZeppelin/openzeppelin-upgrades
Add API docs for `defender.verifyDeployment` and related functions
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 658
- Forks
- 286
- PR merge metrics
- No merged PRs in 30d
Description
Related to https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/642
Add API docs (partially based on this readme content) for the following functions:
- verifyDeployment
- verifyDeploymentWithUploadedArtifact
- getDeploymentArtifact
- getDeploymentBuildInfo
- getBytecodeDigest
Note: Consider having the Defender Hardhat docs in a separate section in the same page (on the right navigation for sections) or in a different page (on the left navigation for pages) from Hardhat Upgrades.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API docs page and the plugin-defender-hardhat README section linked in the issue, then review related PR #642 for context. Document verifyDeployment, verifyDeploymentWithUploadedArtifact, getDeploymentArtifact, getDeploymentBuildInfo, and getBytecodeDigest, and decide whether Defender Hardhat content belongs in its own section or page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100