Blazingly fast, modular and contributor friendly Solidity compiler, written in Rust.
Caution
Solar is under active development and is not yet feature complete. Use it to speed up your development workflows and tooling. Please do not use it in production environments.
- ⚡ Instant compiles and low memory usage (benchmarks)
- 🔍 Expressive and useful diagnostics
- 🧩 Modular, library-based architecture
- 💻 Simple and hackable code base
- 🔄 Compatibility with the latest Solidity language breaking version (0.8.*)
Solar is available through a command-line interface, or as a Rust library.
You can add Solar to your Rust project by adding the following to your Cargo.toml:
[dependencies]
solar = { version = "=0.1.8", package = "solar-compiler", default-features = false }Or through the CLI:
cargo add "solar-compiler@=0.1.8" --rename solar --no-default-featuresYou can see examples of how to use Solar as a library in the examples directory.
Pre-built binaries are available for macOS, Linux and Windows on the releases page and can be installed with the following commands:
- On macOS and Linux:
curl -LsSf https://paradigm.xyz/solar/install.sh | sh - On Windows:
powershell -c "irm https://paradigm.xyz/solar/install.ps1 | iex"
- For a specific version:
curl -LsSf https://paradigm.xyz/solar/v0.1.8/install.sh | sh powershell -c "irm https://paradigm.xyz/solar/v0.1.8/install.ps1 | iex"
You can also use cargo binstall:
- Latest version:
cargo binstall solar-compiler
- For a specific version:
cargo binstall solar-compiler@0.1.8
Or build Solar from source:
- From crates.io:
cargo install solar-compiler --locked
- From GitHub:
cargo install --git https://github.com/paradigmxyz/solar --locked
- From a Git checkout:
git clone https://github.com/paradigmxyz/solar cd solar cargo install --locked --path crates/solar
Once installed, check out the available options:
solar -hHere's a few examples:
# Compile a single file and emit ABI to stdout.
solar Counter.sol --emit abi
# Compile a contract through standard input (`-` file).
echo "contract C {}" | solar -
solar - <<EOF
contract HelloWorld {
function helloWorld() external pure returns (string memory) {
return "Hello, World!";
}
}
EOF
# Compile a file with a Foundry project's remappings.
solar $(forge re) src/Contract.solThe solar-capi crate exposes the compiler through a Solidity-compatible C API.
That same ABI is also the boundary used by the WebAssembly build and the
soljson-compatible JavaScript wrapper.
The C header is the source of truth for the ABI:
crates/capi/include/libsolc.h. The API
accepts Standard JSON input and returns Standard JSON output, matching the
interface used by Solidity's libsolc and raw soljson.js builds. Like
Solidity, client code owns memory explicitly through the C API described in the
header.
Solidity distributes JavaScript compiler builds as soljson.js files. Modern
builds are WebAssembly modules loaded through a JavaScript wrapper, with the
wasm bytes made available as Module.wasmBinary. The JavaScript package
solc-js then layers a higher-level API over that raw module.
This repository ships the wasm distribution as solar-wasm.tar.gz in releases.
The archive contains:
soljson.js: a packed, soljson-compatible JavaScript file with wasm embedded.solar.wasm: the raw WebAssembly module.soljson-wrapper.js: the JavaScript wrapper for loadingsolar.wasmyourself.
There are two ways to use the wasm and JavaScript distribution:
-
Download
solar-wasm.tar.gzfrom a release and extract the file you need. Usesoljson.jsfor the most solc-js-compatible path, or usesolar.wasmwithsoljson-wrapper.jswhen you want to control wasm loading. -
Build the same files from source:
rustup target add wasm32-unknown-unknown
scripts/wasm/dist-wasm.shThis produces the same files under target/dist/. The script builds with an
exported, growable WebAssembly table so JavaScript callbacks can be installed,
then packs the wasm bytes into soljson.js.
Use the packed soljson.js directly:
const solar = require("./soljson.js");
const output = solar.compile(JSON.stringify({
language: "Solidity",
sources: {
"A.sol": { content: 'import "B.sol"; contract A is B {}' },
},
settings: { outputSelection: { "*": { "*": ["abi"] } } },
}), {
import(path) {
if (path === "B.sol") {
return { contents: "contract B {}" };
}
return { error: `source not found: ${path}` };
},
});For custom wasm loading, use soljson-wrapper.js from the release archive or
crates/capi/soljson.js from source.
In Node, load the separate wasm bytes through the same Module.wasmBinary
hook used by the packed file:
const fs = require("node:fs");
globalThis.Module = {
wasmBinary: fs.readFileSync("./solar.wasm"),
};
const solar = require("./soljson-wrapper.js");
delete globalThis.Module;
const output = solar.compile(JSON.stringify({
language: "Solidity",
sources: {
"A.sol": { content: 'import "B.sol"; contract A is B {}' },
},
settings: { outputSelection: { "*": { "*": ["abi"] } } },
}), {
import(path) {
if (path === "B.sol") {
return { contents: "contract B {}" };
}
return { error: `source not found: ${path}` };
},
});In browsers, serve solar.wasm and soljson-wrapper.js, fetch the wasm bytes,
assign globalThis.Module = { wasmBinary }, and then load the wrapper script.
The wrapper exposes the solc-js-style Standard JSON compile entry point plus
metadata helpers. Legacy low-level solc-js entry points are intentionally set to
null.
You can find a more detailed list in the pinned GitHub issue.
- Front-end
- Lexing
- Parsing
- Semantic analysis
- Symbol resolution
- Type checker
- Static analysis
- Middle-end
- Back-end
Solar's versioning tracks compatibility for the binaries, not the API.
If using this as a library, be sure to pin the version with a = version requirement operator.
Solar always aims to stay up-to-date with the latest stable Rust release.
The Minimum Supported Rust Version (MSRV) may be updated at any time, so we can take advantage of new features and improvements in Rust.
Contributions are welcome and highly appreciated. To get started, check out the contributing guidelines.
Having trouble? Check out the existing issues on GitHub, or feel free to open a new one.
You can also ask for help on Telegram.
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.