foundry README

The project's README from github.com/foundry-rs/foundry. As one markdown file: README.md.

Foundry banner

 

Github Actions Telegram Chat Telegram Support

Install | Docs | Benchmarks | Developer Guidelines | Contributing | Crate Docs


Blazing fast, portable and modular toolkit for Ethereum application development, written in Rust.

Demo

Installation

curl -L https://foundry.paradigm.xyz | bash
foundryup

See the installation guide for more details.

To verify a downloaded release archive or container image, see Verifying Releases.

Getting Started

Initialize a new project, build and test:

forge init counter && cd counter
forge build
forge test

Interact with a live network:

cast block-number --rpc-url https://eth.merkle.io
cast balance vitalik.eth --ether --rpc-url https://eth.merkle.io

Fork mainnet locally:

anvil --fork-url https://eth.merkle.io

Read the Foundry Docs to learn more.

Solidity editor integration

Configure your editor's Solidity language server command as forge lsp. The server is embedded in Forge, so the standalone solar executable is not required. Solar uses foundry.toml, workspace folders, remappings, and evm_version from the project automatically.

Solar's default flycheck runs forge lint --json with the same Forge executable that started the server. Solar's existing initializationOptions.forgePath option overrides that executable.

forge lsp follows Forge's normal environment setup, global-option parsing, and command dispatch. Project dotenv warnings use stderr, leaving stdout reserved for the LSP transport.

Contributing

Contributions are welcome and highly appreciated. To get started, check out the contributing guidelines.

Join our Telegram to chat about the development of Foundry.

Support

Having trouble? Check the Foundry Docs, join the support Telegram, or open an issue.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in these crates by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

foundry (foundry-rs/foundry)

Searching Database…

10.7K ·GitHub
What is this?Foundry is a blazing fast, portable and modular toolkit for Ethereum application development, written in Rust. It bundles four command-line tools: Forge, Cast, Anvil and Chisel.
Is it one tool or a whole suite?A suite of four CLIs: Forge builds, tests, fuzzes, debugs and deploys Solidity contracts; Cast works with contracts, transactions and chain data; Anvil is a fast local Ethereum node; Chisel is a Solidity REPL.
How do I install it and start my first project?Install with the official installer (foundryup) from the installation guide, then run forge init to scaffold a project and forge build and forge test to compile and test it.
Do I need anything else installed before it will run?Nothing — it ships as self-contained release archives and Docker images, so no extra runtime or language stack is needed.
Does it work on Windows or just Mac and Linux?It is cross-platform: portable Rust binaries run on macOS, Linux and Windows, and Docker images are published too.
What does a typical development loop look like?After forge init and forge build/test, cast handles live networks — sending transactions and reading chain data — while anvil gives you a fast local node and can fork mainnet so you test against real chain state.
Can I hook it into my editor?Point your Solidity language server command at 'forge lsp'. The server is embedded in Forge, picks up foundry.toml, workspace folders, remappings and the EVM version automatically, and runs forge lint --json as its default flycheck.
What is Chisel for?Chisel is a fast, utilitarian and verbose Solidity REPL — a quick way to experiment with Solidity code without a full project setup.
Is it Solidity-only, or does it handle Vyper too?The README centers on Solidity: Forge, the Solar language server and Chisel are Solidity-focused. Vyper appears only in the repo's topic list, so treat Vyper support as secondary.
Creator
foundry-rs
Size
90.1 MB
Stars
10.7K
Age
5y
Commits · 90 Days