Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new config fields to ignition docs #5758

Merged
merged 3 commits into from
Sep 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/src/content/ignition/docs/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ module.exports = {
timeBeforeBumpingFees: 3 * 60 * 1_000,
maxFeeBumps: 4,
requiredConfirmations: 5,
disableFeeBumping: false,
},
};
```
Expand Down Expand Up @@ -44,6 +45,12 @@ The number of confirmations Hardhat Ignition waits before considering a transact

Default value: 5

### `disableFeeBumping`

If set to `true`, Hardhat Ignition will not bump the fee for unconfirmed transactions. Overrides the `disableFeeBumping` option in the network configuration.

Default value: false

## Network configuration options

You can use the `ignition` field under specific network configurations to customize deployments on a per-network basis:
Expand All @@ -57,6 +64,8 @@ module.exports = {
ignition: {
maxFeePerGasLimit: 50_000_000_000n, // 50 gwei
maxPriorityFeePerGas: 2_000_000_000n, // 2 gwei
gasPrice: 50_000_000_000n, // 50 gwei
disableFeeBumping: false,
},
// ...
},
Expand All @@ -77,3 +86,15 @@ Default value: undefined
The maximum priority fee per gas, in wei, that Hardhat Ignition will use for gas fee calculations when sending transactions. If not set then Hardhat Ignition will try to use `eth_maxPriorityFeePerGas` if available, or default to 1 gwei.

Default value: undefined

### `gasPrice`

The gas price, in wei, that Hardhat Ignition will use for gas fee calculations when sending transactions. **This field only applies to deployments on the Polygon network. It will not be used on other networks even if set.**

Default value: undefined

### `disableFeeBumping`

If set to `true`, Hardhat Ignition will not bump the fee for unconfirmed transactions on this network. Is overridden by the top-level `disableFeeBumping` option.

Default value: false