Enables creating clone contracts with immutable arguments.
The immutable arguments are stored in the code region of the created proxy contract, and whenever the proxy is called, it reads the arguments into memory, and then appends them to the calldata of the delegate call to the implementation contract. The implementation contract can thus read the arguments straight from calldata.
By doing so, the gas cost of creating clones is reduced, since there's no need to store the immutable arguments in storage. The cost of using the clones is also reduced, since storage loads are replaced with calldata reading, which is far cheaper.
Clone factory contracts should use the ClonesWithImmutableArgs
library. ClonesWithImmutableArgs.clone()
is the main function for creating clones.
Contracts intended to be cloned should inherit from Clone
to get access to the helper functions for reading immutable args.
To see an example usage of the library, check out ExampleClone
and ExampleCloneFactory
.
To install with DappTools:
dapp install wighawag/clones-with-immutable-args
To install with Foundry:
forge install wighawag/clones-with-immutable-args
To install with Hardhat:
npm i -D clones-with-immutable-args
This project uses Foundry as the development framework.
make update
make build
make test