Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/0age/Spawner

Spawn EIP 1167 minimal proxies with an included initialization step during contract creation.
https://github.com/0age/Spawner

ethereum-contract initializer library proxy spawner

Last synced: 3 months ago
JSON representation

Spawn EIP 1167 minimal proxies with an included initialization step during contract creation.

Host: GitHub
URL: https://github.com/0age/Spawner
Owner: 0age
License: mit
Created: 2019-07-24T00:30:42.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-04-16T06:43:08.000Z (about 1 year ago)
Last Synced: 2024-01-25T18:07:53.614Z (5 months ago)
Topics: ethereum-contract, initializer, library, proxy, spawner
Language: Solidity
Size: 919 KB
Stars: 40
Watchers: 5
Forks: 8
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Lists

awesome-solidity - 0age/Spawner - Spawn EIP 1167 minimal proxies with an included initialization step during contract creation. (Libraries)
awesome-solidity - 0age/Spawner - Spawn EIP 1167 minimal proxies with an included initialization step during contract creation. (Libraries)
awesome-solidity - 0age/Spawner - Spawn EIP 1167 minimal proxies with an included initialization step during contract creation. (Libraries)
awesome-solidity - 0age/Spawner - Spawn EIP 1167 minimal proxies with an included initialization step during contract creation. (Libraries)

README

        # Spawner (eip1167-spawner)

[![npm](https://img.shields.io/npm/v/eip1167-spawner.svg?color=brightgreen)](https://www.npmjs.com/package/eip1167-spawner)

[![GitHub](https://img.shields.io/github/license/0age/Spawner.svg?colorB=brightgreen)](https://github.com/0age/Spawner/blob/master/LICENSE.md)

[![Build Status](https://travis-ci.org/0age/Spawner.svg?branch=master)](https://travis-ci.org/0age/Spawner)

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

> Spawn EIP 1167 minimal proxies with an included initialization step during contract creation.

These contracts demonstrate a technique for initializing and deploying [EIP 1167](https://eips.ethereum.org/EIPS/eip-1167) minimal proxies that point to designated logic contracts. Logic contracts should make an initialization function available that only allows it to be called during contract construction (i.e. `assembly { if extcodesize(address) { revert(0, 0) } }`).

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Maintainers](#maintainers)

- [Contribute](#contribute)

- [License](#license)

## Install

To include Spawner as a dependency in your project:

```

$ yarn add eip1167-spawner

```

To install locally, you'll need Node.js 10+ and Yarn *(or npm)*. To get everything set up:

```sh

$ git clone https://github.com/0age/Spawner.git

$ cd Spawner

$ yarn install

$ yarn build

```

## Usage

Import Spawner and inherit it on a contract, then call `_spawn` with the desired logic contract and ABI-encoded initialization calldata:

```Solidity

pragma solidity ^0.5.0;

import "eip1167-spawner/contracts/Spawner.sol";

import "./MyLogicContract.sol";

contract MyFactory is Spawner {

  function spawnIt() public returns (address spawnedContract) {

    MyLogicContract logic = MyLogicContract(address(...));

    

    bytes memory myInitializationCalldata = abi.encodeWithSelector(

      logic.initialize.selector,

      "argumentOne",

      "argumentTwo"

    );

    

    spawnedContract =  _spawn(

      address(logicContract),

      myInitializationCalldata

    );

  }

}

```

You can also use `_spawnCompact` *(for logic contracts with at least five leading zero bytes or ten zeroes)*, `_spawnOldSchool` *(for deploying with `CREATE` rather than `CREATE2`)*, or `_spawnCompactOldSchool`. In addition, you can compute addresses spawned with `CREATE2` ahead of time by using the supplied `_computeNextAddress` and `_computeNextCompactAddress` internal view functions.

Note: Spawner will be careful not to deploy to any address that already has code at it, but watch out - if the code that the minimal proxy points to can cause a `SELFDESTRUCT`, it is possible that Spawner may *redeploy* a minimal proxy to an address it has already deployed to in the past. This may or may not be the intended behavior, so feel free to put in extra safeguards if you're worried about this.

To run tests locally, start the testRPC, trigger the tests, and tear down the testRPC *(you can do all of this at once via* `yarn all` *if you prefer)*:

```sh

$ yarn start

$ yarn test

$ yarn stop

```

## Maintainers

[@0age](https://github.com/0age)

## Contribute

PRs accepted gladly - make sure the tests pass. *(Changes to the contracts themselves should bump the version number and be marked as pre-release.)*

## License

MIT © 2019 0age