Skip to content

wighawag/clones-with-immutable-args

Folders and files

NameName
Last commit message
Last commit date

Latest commit

196f1ec · May 30, 2024

History

71 Commits
Jan 20, 2022
Oct 4, 2021
Jan 17, 2024
Feb 20, 2024
Sep 18, 2023
Jan 20, 2022
Jan 20, 2022
Jan 21, 2022
Feb 20, 2024
Feb 20, 2024
Oct 31, 2023
Jan 21, 2022
Jan 25, 2022
Jul 3, 2022
Sep 18, 2023
May 30, 2024
Feb 20, 2024
Feb 20, 2024
Jan 25, 2022

Repository files navigation

ClonesWithImmutableArgs

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 parametrizable clones is reduced, since there's no need to store the parameters in storage, which you need to do with EIP-1167. The cost of using such clones is also reduced, since storage loads are replaced with calldata reading, which is far cheaper.

In other word, if you know you are not gonna need parametrization and just want exact copies, then you can keep using EIP-1167, otherwise, clones-with-immutables is cheaper.

Usage

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.

Installation

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

Local development

This project uses Foundry as the development framework.

Dependencies

make update

Compilation

make build

Testing

make test