npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@idle-finance/hardhat-proposals-plugin

v0.2.5

Published

Hardhat plugin for governance proposals

Downloads

199

Readme

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