@optionality.io/clone-factory

Create clone contracts with 96 bytes deployed on chain.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@optionality.io/clone-factory
Minified + gzip package size for @optionality.io/clone-factory in KB

Readme

clone-factory

Simple clone contract factory Build Status

Check out the contracts/CloneFactory.sol file for details. This code (intended to be called from an implementor factory contract) will allow you to install a master copy of a contract, then easily (cheaply) create clones with separate state. The deployed bytecode just delegates all calls to the master contract address.

npm install @optionality.io/clone-factory

import "./Thing.sol";
import "@optionality.io/clone-factory/contracts/CloneFactory.sol";
import "zeppelin-solidity/contracts/ownership/Ownable.sol";


contract ThingFactory is Ownable, CloneFactory {

  address public libraryAddress;

  event ThingCreated(address newThingAddress);

  function ThingFactory(address _libraryAddress) public {
    libraryAddress = _libraryAddress;
  }

  function setLibraryAddress(address _libraryAddress) public onlyOwner {
    libraryAddress = _libraryAddress;
  }

  function createThing(string _name, uint _value) public onlyOwner {
    address clone = createClone(libraryAddress);
    Thing(clone).init(_name, _value);
    ThingCreated(clone);
  }
}

This will inexpensively create a mimimalist forwarding shim contract that will delegate all calls to the contract libraryAddress

WARNINGS

  • Be sure that the master contract is pre-initialized. You can usually accomplish this in your constructor as the only time the master contract constructor is called is during the master contract's creation. Clone contracts do not call the constructor, but are initialized with an inline initialization method (as demonstrated above).
  • Do not allow your master contract to be self-destructed as it will cause all clones to stop working, thus freezing their state and balances.

Use vanity contract addresses for even CHEAPER clone contracts

Using vanity-eth generate a vanity contract address with up to 4 bytes of leading zeros and use the CloneFactory16 - CloneFactory18 versions to deploy even smaller clones. HT to wjmelements for pointing this out!

ContractProbe contract

Using this deployed contract d'apps, wallets, or other contracts can detect if an address contains a clone and to what address it redirects to. This contract is deployed at the following addresses:

Build Notes

To run the scripts/r2.js script, you need to have radare2 installed along with the evm module (r2pm install evm).

License

Code released under the MIT License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.