Skip to content

Update Docs and Fix Foundry V1 Breaking Changes #113

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.

Sign up for GitHub

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

Merged
ermyas merged 4 commits into from
Apr 29, 2025
Merged

Update Docs and Fix Foundry V1 Breaking Changes #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eed23b4
Update HLA doc
ermyas Apr 29, 2025
dc4233b
Fix issue resulting from upgrade to Foundry v1
ermyas Apr 29, 2025
5a23fa3
Fix breaking change from Foundry v1
ermyas Apr 29, 2025
609230f
Fix CI Workflow Error
ermyas Apr 29, 2025
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
5 changes: 5 additions & 0 deletions .github/workflows/coverage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ jobs:
with:
submodules: recursive

- name: Set Node.js 18.18.x
uses: actions/setup-node@v3
with:
node-version: 18.18.x

- name: Restore node modules from cache
uses: ./.github/actions/node-cache

Expand Down
2 changes: 1 addition & 1 deletion docs/high-level-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

## Introduction
### Purpose
This document outlines a high-level architecture and threat model for the token bridge between Ethereum ("Root" chain) and the Immutable zkEVM ("Child" chain) chains. The bridge facilitates the transfer of ETH, IMX, and standard ERC20 tokens between these chains, using an underlying General Message Passing (GMP) bridge, Axelar, for message transmission. This bridge is a critical piece of infrastructure for the Immutable zkEVM chain, that will potentially custody significant amount of user assets.
This document outlines a high-level architecture and threat model for the token bridge between Ethereum ("Root" chain) and the Immutable zkEVM ("Child" chain) chains. The bridge facilitates the transfer of ETH, IMX, and standard ERC20 tokens between these chains, using an underlying General Message Passing (GMP) bridge, Axelar, for message transmission. This bridge is a critical piece of infrastructure for the Immutable zkEVM chain.

The purpose of this document is to two-fold:
1. Provide a high-level view of the Immutable zkEVM bridge's architecture, in terms of its core functionalities and use-cases, major components and their interactions, dependencies and architectural characteristics.
Expand Down
6 changes: 5 additions & 1 deletion foundry.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,8 @@ libs = ["lib"]
solc-version = "0.8.19"
# Reason for why this flag is required can be found here: https://github.com/foundry-rs/foundry/issues/7607
unchecked_cheatcode_artifacts = true
# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
# Reasons for why this flag is required can be found here: https://book.getfoundry.sh/cheatcodes/expect-revert#description
allow_internal_expect_revert = true
# Required because of a breaking change in Foundry v1, which disabled optimizer by default: https://book.getfoundry.sh/guides/v1.0-migration#solc-optimizer-disabled-by-default
optimizer = true
optimizer_runs = 200
Loading