Skip to content

Commit

Permalink
feat: add ignition to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Eikix committed Apr 3, 2024
1 parent 4bb1955 commit 8ec899b
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 deletions.
8 changes: 4 additions & 4 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ runtimes:
# This is the section where you manage your linters. (https://docs.trunk.io/check/configuration)
lint:
enabled:
- checkov@3.2.39
- checkov@3.2.50
- git-diff-check
- markdownlint@0.39.0
- osv-scanner@1.6.2
- osv-scanner@1.7.0
- oxipng@9.0.0
- prettier@3.2.5
- svgo@3.2.0
- trivy@0.49.1
- trufflehog@3.70.1
- trivy@0.50.1
- trufflehog@3.71.0
actions:
disabled:
- trunk-announce
Expand Down
2 changes: 1 addition & 1 deletion docs/ecosystem/data-indexers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Data Indexers
sidebar_position: 1
sidebar_position: 2
---

## Overview
Expand Down
42 changes: 42 additions & 0 deletions docs/ecosystem/sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: SDKs and Libraries
sidebar_position: 1
---

## Overview

Welcome to the SDKs page! Find useful information about SDKs and Libraries (e.g.
Foundry, Viem, Hardhat), such as recommended configuration or known issues.

### Hardhat

> [Hardhat](https://hardhat.org/) is a development environment for Ethereum
> software. It consists of different components for editing, compiling,
> debugging and deploying your smart contracts and dApps, all of which work
> together to create a complete development environment.
#### Hardhat Ignition

> Hardhat Ignition is a declarative system for deploying smart contracts on
> Ethereum.
We recommend users to pay attention to the
[configuration of Ignition on Kakarot Sepolia](https://hardhat.org/ignition/docs/config#requiredconfirmations).

There are some known issues with the default Ignition configuration. For
instance, no. of block confirmations required by ignition to prevent re-orgs
defaults to 5. We recommend users to set this to 1 in Kakarot Sepolia. Another
example is that Kakarot does not support fee bumping since it has no fee market
(FIFO system).

```js
// hardhat.config.js
module.exports = {
ignition: {
blockPollingInterval: 3_000,
timeBeforeBumpingFees: 3 * 60 * 1_000,
maxFeeBumps: 0,
requiredConfirmations: 1,
},
};
```

0 comments on commit 8ec899b

Please sign in to comment.