hardhat-fe

Hardhat plugin to develop smart contracts with Fe

What

This plugin adds support for Fe to Hardhat. Once installed, Fe contracts can be compiled by running the compile task.

This plugin plans to generate the same artifact format as the built-in Solidity compiler, so that it can be used in conjunction with all other plugins.

The Fe compiler is run using the official binary releases.

Installation

First, you need to install the plugin by running

npm install --save-dev @fe-lang/hardhat-fe

And add the following statement to your hardhat.config.js:

require("@fe-lang/hardhat-fe");

Or, if you are using TypeScript, add this to your hardhat.config.ts:

import "@fe-lang/hardhat-fe";

Required plugins

No plugins dependencies.

Tasks

This plugin creates no additional tasks.

Environment extensions

This plugin does not extend the Hardhat Runtime Environment.

Configuration

This plugin adds an optional fe entry to Hardhat's config, which lets you specify the Fe version to use.

This is an example of how to set it:

module.exports = {
  fe: {
    version: "0.19.1-alpha",
  },
};

Or you can use a customized compiler by specifying the path to the binary instead of downloading from official releases:

module.exports = {
  fe: {
    compilerPath: "absolute_path_to_fe_compiler_binary",
  },
};

Otherwise, if you leave the fe config entry blank, the plugin will use the default version of Fe compiler which currently is 0.19.1-alpha

Usage

There are no additional steps you need to take for this plugin to work.

Known issues

since Fe is still under heavy development

• the abi file generated by Fe compiler does not contain deployedBytecode attribute
• the abi file generated by Fe compiler does not contain stateMutability attribute, related issue

Development

npm install // install dependencies
npm run build // build before publish
npm run test // run tests