@idle-finance/hardhat-proposals-plugin
TypeScript icon, indicating that this package has built-in type declarations

0.2.5 • Public • Published

Node.js CI

hardhat-proposals-plugin

A Hardhat plugin for working with on-chain proposals

What

A helper plugin for developing and testing on-chain proposals

This plugin will assist in simulating proposals in a Hardhat environment for testing and debugging proposals before they are submitted on-chain.

Installation

npm install --save-dev @idle-finance/hardhat-proposals-plugin @nomiclabs/hardhat-ethers ethers

Import the plugin in your hardhat.config.js:

require("@idle-finance/hardhat-proposals-plugin");

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

import "@idle-finance/hardhat-proposals-plugin";

Required plugins

Tasks

This plugin adds the proposal task to Hardhat:

Usage: hardhat [GLOBAL OPTIONS] proposal [--action <STRING>] --governor <STRING> --voting-token <STRING> id

OPTIONS:

  --action              What type of action to perform from options (info) (default: "info") (default: "info")
  --governor            The governor address 
  --voting-token        The voting token registered with the governor 

POSITIONAL ARGUMENTS:

  id    The proposal id 

proposal: Interact with proposals using hardhat

Environment extensions

This plugin extends the Hardhat Runtime Environment by adding the proposal field whose type is ProposalsHardHatRunTimeEnvironmentField

Configuration

This plugin extends the HardhatUserConfig by adding the proposals field whose type is ProposalsUserConfig

This is an example of how to set it:

module.exports = {
  proposals: {
    governor: "0x2256b25CFC8E35c3135664FD03E77595042fe31B",
    votingToken: "0x875773784Af8135eA0ef43b5a374AaD105c5D39e"
  }
};

Usage

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

Install it and access proposals through the Hardhat Runtime Environment anywhere you need it (tasks, scripts, tests, etc).

Example

The following example illustrates how to use the plugin.

This example will create a proposal for a GovernorAlpha like proposal.

...
export default task(..., async(args, hre) => {
  ...
  let proposer = await hre.ethers.getSigner(PROPOSER)

  let proposal = hre.proposals.builders.alpha()
    .setProposer(proposer)
    .addContractAction(
      DAIInterestRateModelV2, // Contract we are interacting with
      "_setInterestRateModel(address)", // Contract signature
      ['0'] // Method args
    )
    .setDescription("CIP #2 ...") // Set proposal description
    .build()

  await proposal.simulate() // Simulate the execution of the proposal.
})

A full project implementation using this plugin can be found here

Package Sidebar

Install

npm i @idle-finance/hardhat-proposals-plugin

Weekly Downloads

0

Version

0.2.5

License

Apache-2.0

Unpacked Size

649 kB

Total Files

84

Last publish

Collaborators

  • asafsilman
  • mpandolfi
  • bugduino