Benchmarks for popular implementations of contract standards.
⚠️ The gas usage shown in the benchmarks doesn't take into account the 21k gas added to every ethereum transaction
You can see benchmarks for different compiler versions on benchmarks/
The file data.json
provides a json format of all the data used in the benchmarks. That file is generated by running the command make json
.
We create a minimal implementation of each contract that uses the specific implementation as a base. Then for each of the methods we want to benchmark, we create a test contract that set the environment in the setUp
function and each test only runs the specific function we're benchmarking, trying to reduce the noise as much as possible.
The gas usage shown here is not 100% accurate, but it's good enough to be able to compare the gas usage between the implementations.
All tests are generated using the template files in templates
All tables in the readmes are generated using the scripts in scripts
There are many ways to contribute to this project
- Add a snapshot for the latest solc version
- Add or suggest a contract implementation (the instructions for adding are below)
- Update a contract implementation
- Enhance the codegen scripts
- Install foundry http://getfoundry.sh
- You'll need python 3 installed to run the scripts under the
scripts
folder - Install the python dependencies
pip install -r requirements.txt
git clone --recurse-submodules https://github.com/alephao/solidity-benchmarks.git
- Create a minimal implementation on
src/
, the contract name and file name should follow the convention<Contract Type>_<Variation>
. - Implement the common interface that is in other files of the same contract type (for ERC721 for example, it's
mint
andsafeMint
functions) - Add an entry to the
contracts.<contract type>.variations
property on test-cases.yml, following the examples there. - Add an entry to scripts/.py's
variants
var following the examples there. It should map the variant name you used in the contract likeERC721_<Variant>
to the name you want to appear on the table. E.g.: - In case you added an ERC721 that's also ERC2309 compliant, add a another contract in the same file following the convention
<Contract Type>_<Variation>_ERC2309
, and add an entry to thecontracts.ERC721.ERC2309Variations
in the test-cases.yml
variations = {
"OZ": "OpenZeppelin",
"OZEnumerable": "OpenZeppelin Enumerable",
"OZConsecutive": "OpenZeppelin Consecutive",
"Solady": "Solady",
"Solmate": "Solmate",
"A": "ERC721A",
"B": "ERC721B",
"K": "ERC721K",
}
- Run the following commands:
make codegen
make snapshot
make readme
make json
- Add the contract to the list at the top of the
<Contract Type>.md
. (If you added a new ERC721, update the list on top ofERC721.md
)
ERC20
ERC721
ERC1155