Hardhat Bytecode Exporter

Export Ethereum smart contract bytecode on compilation via Hardhat.

Installation

npm install --save-dev @solidstate/hardhat-bytecode-exporter
# or
pnpm add -D @solidstate/hardhat-bytecode-exporter

Usage

Load plugin in Hardhat config:

import hardhatBytecodeExporter from '@solidstate/hardhat-bytecode-exporter';

const config: HardhatUserConfig = {
  plugins: [
    hardhatBytecodeExporter,
  ],
  bytecodeExporter: {
    ... // see table for configuration options
  },
};

Add configuration under the bytecodeExporter key:

option	description	default
path	path to bytecode export directory (relative to Hardhat root)	'./bytecode'
runOnCompile	whether to automatically export bytecode during compilation	false
clear	whether to delete old bytecode 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	[]
rename	Function with signature (sourceName: string, contractName: string) => string used to rename an exported bytecode (incompatible with flat option)	undefined

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

bytecodeExporter: {
  path: './data',
  runOnCompile: true,
  clear: true,
  flat: true,
  only: [':ERC20$'],
}

// or

bytecodeExporter: [
  {
    path: './only',
    runOnCompile: true,
    only: [':ERC20$'],
  },
  {
    path: './except',
    except: [':ERC20$'],
  },
]

The included Hardhat tasks may be run manually:

npx hardhat bytecode export
npx hardhat bytecode clean
# or
pnpm hardhat bytecode export
pnpm hardhat bytecode clean

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

npx hardhat bytecode export --no-compile
# or
pnpm hardhat bytecode export --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.

Bytecode files are saved as a flat bin file in the format [CONTRACT_NAME].bin.

Development

Install dependencies via pnpm:

pnpm install

Setup Husky to format code on commit:

pnpm prepare