Skip to content

Consensys/quorum-remix

Repository files navigation

quorum

Quorum Plugin for Remix

The Quorum plugin for Ethereum's Remix IDE adds support for creating and interacting with private contracts on a Quorum network.

screenshot

Getting Started

Just go to the Remix IDE and activate the Quorum Network plugin on the plugins page. For step-by-step instructions, go to the Getting Started doc.

Common Issues

CORS Issues:

  • Make sure you have CORS enabled in your Quorum and Tessera configurations. Also, if you are connecting to an http url (like http://localhost:22000), make sure you are using the http version of Remix. If you are on the https Remix site, sometimes your browser will block cross-origin requests to non-secure urls.

Contributing

Quorum Plugin for Remix is built on open source and we invite you to contribute enhancements. Upon review you will be required to complete a Contributor License Agreement (CLA) before we are able to merge. If you have any questions about the contribution process, please feel free to send an email to info@goquorum.com.

Development Setup

  • Clone the repo and run:
yarn install
yarn start
  • This will start the webpack development server and serve the plugin at http://localhost:3000
  • Go to our dev version of Remix IDE. Make sure you connect to the http version of the site, not https.
  • Click on the plugins tab
  • Activate the Quorum Network plugin
  • The extension should automatically reload with any changes you make.

Testing

The Quorum plugin uses NightwatchJS to run integration tests on chrome and firefox.

First you need to make a copy of .env.local.template called .env.local Then either replace the password placeholder with the rpc password, or uncomment the bottom section to use your local 7nodes instance to run the tests.

Once those environment variables are set up, run one of the following:

yarn test_chrome
yarn test_firefox

To extend or add new tests, go to the test-browser/tests folder.

Building

yarn build to run a production build of the plugin. The output is in the build/ directory. yarn serve to serve the build folder from port 3000

Getting Help

Stuck at some step? Please join our slack community for support.