Skip to content

Commit 81d3eb4

Browse files
committed
fix: adding foundry admonition for anvil and forge test
1 parent 6933f0c commit 81d3eb4

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

develop/smart-contracts/dev-environments/foundry.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,14 @@ description: Learn to install, configure, and use foundry-polkadot for smart con
55

66
# Foundry
77

8+
!!! warning
9+
Consider that features like Anvil (Foundry's local blockchain) and `forge test` (for running Solidity tests) are not yet supported in `foundry-polkadot`.
10+
11+
## Introduction
12+
813
[`foundry-polkadot`](https://github.com/paritytech/foundry-polkadot/){target=\_blank} is an adaptation specifically engineered for the Polkadot Hub, it's tailored for developers already familiar with Foundry who are seeking to leverage its capabilities within the Polkadot ecosystem. Additionally, this guide offers detailed information on the `forge` and `cast` commands supported within `foundry-polkadot`, complete with simple, runnable examples for quick reference.
914

10-
### Installation
15+
## Installation
1116

1217
The installation process is tailored for the Polkadot variant:
1318

@@ -25,7 +30,7 @@ The installation process is tailored for the Polkadot variant:
2530

2631
This command will install the `forge` and `cast` binaries, which are explained below. Windows users must use a Unix-like terminal environment such as Git BASH or Windows Subsystem for Linux (WSL), as PowerShell and Command Prompt are not currently supported by `foundryup`.
2732

28-
### Compiler Integration
33+
## Compiler Integration
2934

3035
A core divergence lies in the underlying Solidity compiler.
3136

@@ -49,11 +54,11 @@ A core divergence lies in the underlying Solidity compiler.
4954
Setting `resolc_compile = false` reverts to using `solc`, ensuring compatibility with Ethereum projects. By default, `foundry-polkadot` uses `solc` unless `resolc` is explicitly enabled. `resolc` also exposes specific options for fine-tuning the compilation process, such as `--use-resolc <RESOLC_VERSION>` for specifying a compiler version or path, `-O, --resolc-optimizer-mode <LEVEL>` for setting optimization levels, and `--heap-size <SIZE>` and `--stack-size <SIZE>` for configuring contract memory.
5055
5156
52-
### Command-Line Interface (CLI)
57+
## Command-Line Interface (CLI)
5358
5459
`foundry-polkadot` preserves the familiar `forge` and `cast` subcommand structure. However, it's crucial to note that commands which involve compilation (such as `create`, `bind`, `build`, and `inspect`) will yield different output when `resolc` is utilized, as the generated bytecode is specifically designed for PolkaVM rather than the EVM.
5560

56-
### Unsupported or Modified Features
61+
## Unsupported or Modified Features
5762

5863
Not all functionalities from the original Foundry are present or behave identically in `foundry-polkadot`:
5964

llms.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6985,9 +6985,14 @@ description: Learn to install, configure, and use foundry-polkadot for smart con
69856985

69866986
# Foundry
69876987

6988+
!!! warning
6989+
Consider that features like Anvil (Foundry's local blockchain) and `forge test` (for running Solidity tests) are not yet supported in `foundry-polkadot`.
6990+
6991+
## Introduction
6992+
69886993
[`foundry-polkadot`](https://github.com/paritytech/foundry-polkadot/){target=\_blank} is an adaptation specifically engineered for the Polkadot Hub, it's tailored for developers already familiar with Foundry who are seeking to leverage its capabilities within the Polkadot ecosystem. Additionally, this guide offers detailed information on the `forge` and `cast` commands supported within `foundry-polkadot`, complete with simple, runnable examples for quick reference.
69896994

6990-
### Installation
6995+
## Installation
69916996

69926997
The installation process is tailored for the Polkadot variant:
69936998

@@ -7005,7 +7010,7 @@ The installation process is tailored for the Polkadot variant:
70057010

70067011
This command will install the `forge` and `cast` binaries, which are explained below. Windows users must use a Unix-like terminal environment such as Git BASH or Windows Subsystem for Linux (WSL), as PowerShell and Command Prompt are not currently supported by `foundryup`.
70077012

7008-
### Compiler Integration
7013+
## Compiler Integration
70097014

70107015
A core divergence lies in the underlying Solidity compiler.
70117016

@@ -7029,11 +7034,11 @@ A core divergence lies in the underlying Solidity compiler.
70297034
Setting `resolc_compile = false` reverts to using `solc`, ensuring compatibility with Ethereum projects. By default, `foundry-polkadot` uses `solc` unless `resolc` is explicitly enabled. `resolc` also exposes specific options for fine-tuning the compilation process, such as `--use-resolc <RESOLC_VERSION>` for specifying a compiler version or path, `-O, --resolc-optimizer-mode <LEVEL>` for setting optimization levels, and `--heap-size <SIZE>` and `--stack-size <SIZE>` for configuring contract memory.
70307035

70317036

7032-
### Command-Line Interface (CLI)
7037+
## Command-Line Interface (CLI)
70337038

70347039
`foundry-polkadot` preserves the familiar `forge` and `cast` subcommand structure. However, it's crucial to note that commands which involve compilation (such as `create`, `bind`, `build`, and `inspect`) will yield different output when `resolc` is utilized, as the generated bytecode is specifically designed for PolkaVM rather than the EVM.
70357040

7036-
### Unsupported or Modified Features
7041+
## Unsupported or Modified Features
70377042

70387043
Not all functionalities from the original Foundry are present or behave identically in `foundry-polkadot`:
70397044

0 commit comments

Comments
 (0)