2.4 KiB
revive
YUL and EVM assembly recompiler to LLVM, targetting RISC-V on PolkaVM.
Frontend and code generator are based of ZKSync zksolc.
Status
This is experimental software in active development and not ready just yet for production usage.
Discussion around the development is hosted on the Polkadot Forum.
Installation
resolc depends on the solc binary installed on your system.
To install the resolc Solidity frontend executable:
bash build-llvm.sh
export PATH=${PWD}/llvm18.0/bin:$PATH
make install-bin
resolc --version
LLVM
revive requires a build of LLVM 18.1.4 or later including compiler-rt. Use the provided build-llvm.sh build script to compile a compatible LLVM build locally in $PWD/llvm18.0 (don't forget to add that to $PATH afterwards).
Cross-compilation to WASM
Cross-compiles the Revive recompiler to WASM to enable it to run in a Node.js or browser environment.
Install emscripten. Tested on version 3.1.64. To build resolc.js execute:
bash build-llvm.sh
export PATH=${PWD}/llvm18.0/bin:$PATH
export EMSDK_ROOT=<PATH_TO_EMSCRIPTEN_SDK>
bash emscripten-build-llvm.sh
source $EMSDK_ROOT/emsdk_env.sh
export LLVM_LINK_PREFIX=${PWD}/llvm18.0-emscripten
export PATH=$PATH:$PWD/llvm18.0-emscripten/bin/
make install-wasm
Development
Please consult the Makefile targets to learn how to run tests and benchmarks.
Ensure that your branch passes make test locally when submitting a pull request.
Design overview
revive uses solc, the Ethereum Solidity compiler, as the Solidity frontend to process smart contracts written in Solidity. The YUL IR code (or legacy EVM assembly as a fallback for older solc versions) emitted by solc is then translated to LLVM IR, targetting Polkadots revive pallet.