Package Health Score

49 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.10.1	\|	10/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.9.0	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.8.0	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.7.2	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.6.1	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (6,281)

GitHub Stars: 76
Forks: 20
Contributors: 9

Direct Usage Popularity

The npm package hardhat-abi-exporter receives a total of 6,281 downloads a week. As such, we scored hardhat-abi-exporter popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package hardhat-abi-exporter, we found that it has been starred 76 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like hardhat-abi-exporter is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 3
Last Release: 2 years ago
Last Commit: 15 days ago

Further analysis of the maintenance status of hardhat-abi-exporter based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for hardhat-abi-exporter is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14.14.0

Age: 4 years
Dependencies: 2 Direct
Versions: 28
Install Size: 13.9 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: Yes

hardhat-abi-exporter has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Hardhat ABI Exporter

Export Ethereum smart contract ABIs on compilation via Hardhat.

Versions of this plugin prior to 2.0.0 were released as buidler-abi-exporter.

Installation

npm install --save-dev hardhat-abi-exporter
# or
yarn add --dev hardhat-abi-exporter

Usage

Load plugin in Hardhat config:

require('hardhat-abi-exporter');

Add configuration under the abiExporter key:

option	description	default
`path`	path to ABI export directory (relative to Hardhat root)	`'./abi'`
`runOnCompile`	whether to automatically export ABIs during compilation	`false`
`clear`	whether to delete old ABI files in `path` on compilation	`false`
`flat`	whether to flatten output directory (may cause name collisions)	`false`
`only`	`Array` of `String` matchers used to select included contracts, defaults to all contracts if `length` is 0	`[]`
`except`	`Array` of `String` matchers used to exclude contracts	`[]`
`spacing`	number of spaces per indentation level of formatted output	`2`
`pretty`	whether to use interface-style formatting of output for better readability	`false`
`format`	format type ("json", "minimal", "fullName"). Alternative to `pretty`	`json`
`filter`	`Function` with signature `(abiElement: any, index: number, abi: any, fullyQualifiedName: string) => boolean` used to filter elements from each exported ABI	`() => true`
`rename`	`Function` with signature `(sourceName: string, contractName: string) => string` used to rename an exported ABI (incompatible with `flat` option)	`undefined`

Note that the configuration formatted as either a single Object, or an Array of objects. An Array may be used to specify multiple outputs.

abiExporter: {
  path: './data/abi',
  runOnCompile: true,
  clear: true,
  flat: true,
  only: [':ERC20$'],
  spacing: 2,
  pretty: true,
  format: "minimal",
}

// or

abiExporter: [
  {
    path: './abi/pretty',
    pretty: true,
  },
  {
    path: './abi/ugly',
    pretty: false,
  },
]

// or

abiExporter: [
  {
    path: './abi/json',
    format: "json",
  },
  {
    path: './abi/minimal',
    format: "minimal",
  },
  {
    path: './abi/fullName',
    format: "fullName",
  },
]

The included Hardhat tasks may be run manually:

npx hardhat export-abi
npx hardhat clear-abi
# or
yarn run hardhat export-abi
yarn run hardhat clear-abi

By default, the hardhat compile task is run before exporting ABIs. This behavior can be disabled with the --no-compile flag:

npx hardhat export-abi --no-compile
# or
yarn run hardhat export-abi --no-compile

The path directory will be created if it does not exist.

The clear option is set to false by default because it represents a destructive action, but should be set to true in most cases.

ABIs files are saved in the format [CONTRACT_NAME].json.

hardhat-abi-exporter dependencies

@ethersproject/abi delete-empty

hardhat-abi-exporter development dependencies

eslint hardhat

FAQs

What is hardhat-abi-exporter?

Export Ethereum smart contract ABIs on compilation. Visit Snyk Advisor to see a full health score report for hardhat-abi-exporter, including popularity, security, maintenance & community analysis.

Is hardhat-abi-exporter popular?

The npm package hardhat-abi-exporter receives a total of 6,281 weekly downloads. As such, hardhat-abi-exporter popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is hardhat-abi-exporter well maintained?

We found indications that hardhat-abi-exporter is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is hardhat-abi-exporter safe to use?

While scanning the latest version of hardhat-abi-exporter, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 6 November-2024, at 10:30 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

hardhat-abi-exporter

Export Ethereum smart contract ABIs on compilation For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (6,281)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

Hardhat ABI Exporter

Installation

Usage

hardhat-abi-exporter dependencies

hardhat-abi-exporter development dependencies

FAQs

What is hardhat-abi-exporter?

Is hardhat-abi-exporter popular?

Is hardhat-abi-exporter well maintained?

Is hardhat-abi-exporter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6,281)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Hardhat ABI Exporter

Installation

Usage

hardhat-abi-exporter dependencies

hardhat-abi-exporter development dependencies

FAQs

What is hardhat-abi-exporter?

Is hardhat-abi-exporter popular?

Is hardhat-abi-exporter well maintained?

Is hardhat-abi-exporter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues