1.0.0 • Published 3 years ago

@aragon/hardhat-aragon v1.0.0

Weekly downloads
-
License
AGPL-3.0-or-later
Repository
github
Last release
3 years ago

Aragon Hardhat plugin

Hardhat plugin for publishing Aragon apps and templates.

Required plugins

This plugin currently requires:

Installation

yarn add --dev @aragon/hardhat-aragon @nomiclabs/hardhat-ethers ethers @nomiclabs/hardhat-etherscan

And add the following statement to your hardhat.config.js:

require('@aragon/hardhat-aragon')
require('@nomiclabs/hardhat-ethers')
require('@nomiclabs/hardhat-etherscan')

Or, if you are using TypeScript, add this to your hardhat.config.ts:

import '@aragon/hardhat-aragon'
import '@nomiclabs/hardhat-ethers'
import '@nomiclabs/hardhat-etherscan'

Tasks

This plugin provides the publish task which allows you to publish an Aragon app to the Aragon Package Manager

Usage

hardhat publish --contract <STRING> --ipfs-api-url <STRING> [--dry-run] [--only-content] [--skip-app-build] [--skip-validation] [--verify] [--confirmations <blocks>] [--constructor-args-path <path>] bump [...constructorArgsParams]

Options

  • --contract Contract previously deployed
  • --dry-run Output transaction data without broadcasting
  • --only-content Prevents contract compilation, deployment, and artifact generation
  • --skip-app-build Prevents building application
  • --skip-validation Prevents validation of artifact files
  • --ipfs-api-url Url to upload app content to IFPS
  • --verify Automatically verify contract
  • --confirmations Wait this number of blocks of confirmation for contract creation. Default to 1. Etherscan recommends waiting 5 blocks before verifying to ensure transaction available at etherscan's node
  • --constructor-args-path File path to a javascript module that exports the list of contract constructor arguments

Positional Arguments

  • bump Type of bump (major, minor, patch) or sematic version. Use major for contract change.
  • constructorArgsParams Constructor arguments for the app contract, Ignored if the --constructor-args-path option is used. default [].