README.md

Welcome to truffle-proxy

Winning project at ConsenSys Grants Hackathon - New York - July 2019

See truffle-proxy-ui here

Extend Truffle CLI with EIP-1822 proxy support. Proxy support provides a simple upgrade path for contracts to maintain storage, while making changes to the underlying contract implementation.

Install

// tip: to start a new truffle project:
// truffle init
// within your truffle project:
npm init -y
npm install --save-dev git+https://github.com/mdcoon/truffle-proxy

Add the following to your truffle-config.js

  plugins: [
    "truffle-proxy"
  ]

Usage

Add proxy support to a truffle project

Generates EIP-1820 compatible proxy implementation along with example files and unit tests for your project.

truffle run create-proxy

Run unit tests

Executes all unit tests against an embedded Ganache blockchain compatible with proxy contract.

truffle run test-proxy

Display summary network info

Displays a summary of network / address information for deployed contracts. Includes details highlighting proxy contracts.

truffle run summarize-proxy

Authors

👤 Mike Coon

• Github: @mdcoon

👤 Harvinder Ghotra

• Github: @hghotra

👤 Mitchell Opatowsky

• Github: @official-mitchell

👤 Mike Powers

• Github: @mjpowersjr

👤 Will Shahda

• Github: @opz

Show your support

Give a ⭐️ if this project helped you!