Skip to content

Commit 0eced85

Browse files
Apply suggestions from code review
Co-authored-by: Dawn Kelly <[email protected]>
1 parent a70704c commit 0eced85

File tree

1 file changed

+7
-7
lines changed
  • develop/smart-contracts/dev-environments

1 file changed

+7
-7
lines changed

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

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

1111
## Overview
1212

13-
Foundry is a fast, modular, and extensible toolkit for Ethereum application development, written in Rust. It provides a suite of command-line tools, such as `forge` for compiling, testing, and deploying smart contracts, and `cast` for interacting with blockchains.
13+
Foundry is a fast, modular, and extensible toolkit for Ethereum application development written in Rust. It provides a suite of command-line tools, including `forge` for compiling, testing, and deploying smart contracts and `cast` for interacting with blockchains.
1414

15-
[`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.
15+
[`foundry-polkadot`](https://github.com/paritytech/foundry-polkadot/){target=\_blank} is an adaptation explicitly engineered for the Polkadot Hub, tailored for developers already familiar with Foundry who seek 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.
1616

1717
## Installation
1818

@@ -44,7 +44,7 @@ A core divergence lies in the underlying Solidity compiler.
4444
forge build --resolc
4545
```
4646
47-
This instructs Forge to use `resolc` instead of `solc`, generating bytecode compatible with PolkaVM.
47+
This command instructs Forge to use `resolc` instead of `solc`, generating bytecode compatible with PolkaVM.
4848
4949
- **Configuration File**: Alternatively, you can configure `resolc` usage in the `foundry.toml` file by adding:
5050
@@ -67,7 +67,7 @@ Not all functionalities from the original Foundry are present or behave identica
6767
- **Currently Unsupported**:
6868
- Compilation of Yul code is not yet supported.
6969
- Support for factory contracts deployment is a known issue that is currently unresolved.
70-
- **Broader Feature Limitations**: Integration with `Anvil` and `Chisel` (Foundry's local blockchain and EVM toolkit, respectively) is not available. This directly impacts the support for several key commands, including `forge test` for running tests, `forge snapshot` for creating blockchain state snapshots, and `forge script` for complex deployment and interaction scripts.
70+
- **Broader Feature Limitations**: Integration with `Anvil` and `Chisel` (Foundry's local blockchain and EVM toolkit, respectively) is not available. This limitation directly impacts the support for several key commands, including `forge test` for running tests, `forge snapshot` for creating blockchain state snapshots, and `forge script` for complex deployment and interaction scripts.
7171
- **Modified Feature**: The most notable modification is in the **compilation output**. When ``resolc`` is employed, the resulting bytecode will fundamentally differ from that generated by ``solc``, reflecting PolkaVM's distinct architectural requirements.
7272

7373
## Set up a Project
@@ -79,7 +79,7 @@ forge init my-polkadot-project
7979
cd my-polkadot-project
8080
```
8181

82-
This creates a complete project structure with the following components:
82+
This command creates a complete project structure with the following components:
8383

8484
- **`src/`** - Contains the Solidity smart contracts (includes a sample `Counter.sol` contract by default)
8585
- **`lib/`** - Houses external dependencies and libraries (`forge-std` testing library is included)
@@ -253,7 +253,7 @@ This section provides a detailed breakdown of the `forge` and `cast` commands su
253253
* **Command**: `forge tree`
254254
* **Description**: Displays the dependency tree of your Solidity contracts.
255255

256-
!!!warning "Not Working Commands"
256+
!!!warning "Non-working Commands"
257257

258258
Consider that some foundry commands are not yet supported in `foundry-polkadot`:
259259

@@ -486,7 +486,7 @@ This section provides a detailed breakdown of the `forge` and `cast` commands su
486486
* **Command**: `cast wallet address [OPTIONS]`
487487
* **Description**: Derives and displays the Ethereum address from a private key or mnemonic (if provided).
488488

489-
!!!warning "Not Working Commands"
489+
!!!warning "Non-working Commands"
490490

491491
Consider that some foundry commands are not yet supported in `foundry-polkadot`:
492492

0 commit comments

Comments
 (0)