# wharfnet

> One-command localnet for EVM, Solana, Starknet, Bitcoin, Litecoin & zkSync — boot real dev nodes for every chain your app touches with a single command, with funded accounts, fixed-address test tokens, a unified faucet, chain-control cheats, forking, and a machine-readable manifest for tests and agents.

## Documentation

- [Getting Started](https://sainathr19.github.io/wharfnet/getting-started/): wharfnet runs each chain as a container, so it needs Docker with the Compose plugin (docker compose) and a running daemon.
- [Concepts](https://sainathr19.github.io/wharfnet/concepts/): The mental model behind wharfnet.

## Chains

- [Chains overview](https://sainathr19.github.io/wharfnet/chains/overview/): wharfnet up boots every supported chain side by side behind one config, one manifest, and one status.
- [EVM](https://sainathr19.github.io/wharfnet/chains/evm/): wharfnet up boots two Anvil chains by default — anvil-1 on :8545 and anvil-2 on :8546 — each with pre-deployed test tokens, canonical infra contracts, and a…
- [Solana](https://sainathr19.github.io/wharfnet/chains/solana/): wharfnet up boots a surfpool Solana chain by default (solana-1 on :8899), alongside the other default chains.
- [Starknet](https://sainathr19.github.io/wharfnet/chains/starknet/): wharfnet up boots a starknet-devnet chain by default (starknet-1 on :5050), alongside the other default chains — one command, one manifest, one status.
- [Bitcoin](https://sainathr19.github.io/wharfnet/chains/bitcoin/): wharfnet up boots a bitcoind chain by default (bitcoin-1 on :18443), alongside the other default chains — one command, one manifest, one status.
- [Litecoin](https://sainathr19.github.io/wharfnet/chains/litecoin/): wharfnet up boots a litecoind chain by default (litecoin-1 on :19443), alongside the other default chains — one command, one manifest, one status.
- [zkSync](https://sainathr19.github.io/wharfnet/chains/zksync/): wharfnet up boots an anvil-zksync chain by default (zksync-1 on :8011), alongside the EVM, Starknet, Solana, and Bitcoin/Litecoin chains — one command, one m…

## Reference

- [CLI Reference](https://sainathr19.github.io/wharfnet/reference/cli/): Every wharfnet command, flag, and default.
- [Config Reference (wharfnet.toml)](https://sainathr19.github.io/wharfnet/reference/config/): wharfnet is zero-config: with no wharfnet.toml it boots the default topology.
- [Manifest Reference (wharfnet.json)](https://sainathr19.github.io/wharfnet/reference/manifest/): When wharfnet up boots a localnet it writes a machine-readable manifest to .wharfnet/wharfnet.json.
- [testkit Reference (Rust)](https://sainathr19.github.io/wharfnet/reference/testkit/): wharfnet is a library as well as a CLI.

## Examples & meta

- [Examples](https://sainathr19.github.io/wharfnet/examples/): Two ways to drive a running localnet: from the CLI with the bundled recipe scripts, or from application code with your usual client library pointed at the ma…
- [Changelog](https://sainathr19.github.io/wharfnet/changelog/): Product updates and new capabilities.
- [Contributing](https://sainathr19.github.io/wharfnet/contributing/): Contributions are welcome — issues and PRs alike.

## Full text

- [llms-full.txt](https://sainathr19.github.io/wharfnet/llms-full.txt): the complete documentation as one file.