Hardhat-secure-signer NPM

hardhat-secure-signer

THIS PLUGIN HAS BEEN DEPRECATED DUE TO SECURITY VULNERABILITY. IT IS NOT SUGGESTED FOR USE

About

ALPHA VERSION

This plugin adds a layer of security to your hardhat installation. When running a task, it will prompt you to enter one-time signer credentials or store your credentials in a password encrypted file. This means that you don't need to store your private keys or mnemonics unencrypted on your hard drive.

example:

$ yarn hardhat task-with-signer --network mainnet

[1] 0xd0cd466b34a24fcb2f87676278af2005ca8a78c4
[2] Use one-time private key (do not save private key to hard drive)
[3] Enter and save private key (saves password-encrypted private key to hard drive)
[0] CANCEL

Which wallet would you like to use for signing transactions? [1, 2, 3, 0]:

Installation

npm install hardhat-secure-signer @nomiclabs/hardhat-ethers ethers

Import the plugin in your hardhat.config.js:

require("hardhat-secure-signer");

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

import "hardhat-secure-signer";

Required plugins

Environment extensions

This plugin extends the Hardhat Runtime Environment by adding an askForSigner function.

Usage

To use this plugin from your hardhat tasks, use await hre.askForSigner(). You will be prompted for credentials to enter or save.

e.g.

  const signer = await hre.askForSigner();
  console.log('Signer is', signer.address);

Tasks

This plugin adds an init-signer task to Hardhat:

Usage: hardhat [GLOBAL OPTIONS] init-signer

init-signer: generates encrypted signing key

Todo

make more secure (e.g. remote secret manager integration / add subprocess for accessing signer)
add support for mnemonics
update plugin to extend hardhat-ethers plugin instead
use Wallet.encrypt() to persist wallet data and add alias capabilities