Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
solidity-docgen
Advanced tools
solidity-docgen
solidity-docgen is a program that extracts documentation for a Solidity project.
The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.
This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with usage and configuration.
Install solidity-docgen
from npm.
Include the plugin in your Hardhat configuration.
// hardhat.config.ts
+import 'solidity-docgen';
export default {
+ docgen: { ... }, // if necessary to customize config
};
Then run with hardhat docgen
.
import { docgen } from 'solidity-docgen';
await docgen([{ output: solcOutput }], config);
solcOutput
must be the standard JSON output of the compiler, with at least the ast
output. There can be more than one.
config
is an optional object with the values as specified below.
See config.ts
for the list of options and their documentation.
FAQs
Documentation generator for Solidity smart contracts.
The npm package solidity-docgen receives a total of 8,230 weekly downloads. As such, solidity-docgen popularity was classified as popular.
We found that solidity-docgen demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.