@animoca/ethereum-hardhat-bootstrap

DEPRECATED - HardhHat project bootstrap

Deprecation notice

This repository is now deprecated and not maintained any longer. Use this new library instead: https://github.com/animoca/ethereum-contract-helpers

Introduction

Requirements

A node project must be initialised. If you are starting from zero, start by running the command npm init.

Commands

HardHat contracts template

yarn add -D @animoca/ethereum-hardhat-bootstrap @animoca/ethereum-contracts-core
npx animoca-hardhat-bootstrap -t contracts

HardHat migrations template

yarn add -D @animoca/ethereum-hardhat-bootstrap @animoca/ethereum-migrations-core
npx animoca-hardhat-bootstrap -t migrations

HardHat standalone template

yarn add -D @animoca/ethereum-hardhat-bootstrap @animoca/ethereum-contracts-core @animoca/ethereum-migrations-core
npx animoca-hardhat-bootstrap -t standalone

HardHat project scripts

Bootstrapped HardHat projects come with a set of provided scripts which structure the pipeline execution. The full pipeline (with a few exceptions) can be invoked by running the run-all script as follow:

yarn run-all

HardHat project configuration

Bootstrapped HardHat projects have a more advanced configuration files management:

Release

# runs `npm publish --public` using .npmrc_private configuration
yarn release:private

# runs `npm publish --public` using .npmrc_public configuration
yarn release:public

Suggested

.npmrc_private .npmrc_public