External Plugin

This is a third-party plugin. Please report issues in its GitHub Repository(opens new window)

# Hardhat Packager Coverage Status(opens new window) Styled with Prettier(opens new window) Commitizen Friendly(opens new window) license: WTFPL(opens new window)

Hardhat plugin for preparing the contract artifacts and the TypeChain bindings for registry deployment.

# Description

This plugin builds on top of TypeChain's plugin(opens new window) to prepare your contract artifacts and TypeChain bindings for being deployed to a package registry (e.g. npmjs.org(opens new window) ). More specifically, it deletes all artifacts and bindings that are not in an allowlist of contracts, minifying the folder structure in the process.

# Installation

First, install the plugin and its peer dependencies. If you are using Ethers or Waffle, run:

yarn add --dev hardhat-packager typechain @typechain/hardhat @typechain/ethers-v5

Or if you are using Truffle, run:

yarn add --dev hardhat-packager typechain @typechain/hardhat @typechain/truffle-v5

Second, import the plugin in your hardhat.config.js:

require("@typechain/hardhat");
require("hardhat-packager");

Or if you are using TypeScript, in your hardhat.config.ts:

import "@typechain/hardhat";
import "hardhat-packager";

# Required plugins

# Tasks

This plugin adds the prepare-package task to Hardhat:

Prepares the contract artifacts and the TypeChain bindings for registry deployment

# Configuration

This plugin extends the HardhatUserConfig object with an optional packager object. This object contains one field, contracts. This is an array of strings that represent the names of the smart contracts in your project. The plugin uses this array as an allowlist for the artifacts and the bindings that should be kept for registry deployment.

An example for how to set it:

module.exports = {
  packager: {
    // What contracts to keep the artifacts and the bindings for.
    contracts: ["MyToken", "ERC20"],
    // Whether to include the TypeChain factories or not.
    // If this is enabled, you need to run the TypeChain files through the TypeScript compiler before shipping to the registry.
    includeFactories: true,
  },
};

# Usage

To use this plugin you need to decide which contracts you would like to be part of the package deployed to the registry. Refer to the configuration section above.

Then, run it like this:

yarn hardhat prepare-package

Go look what you have in the artifacts and the typechain folders.

# Tips

# License

The plugin is released under the WTFPL License.