Skip to content

Latest commit

 

History

History
123 lines (94 loc) · 5.52 KB

locations.md

File metadata and controls

123 lines (94 loc) · 5.52 KB
Raw

Remix URLs & Links with Parameters

Embedding & Linking to Remix

Remix-IDE's urls have parameters -so it is possible to specify:

  • A list of plugins to be activated - as well as which plugin you want to be loaded in the side panel (so it gains the "focus").
  • A Command to be sent to a plugin - once the plugin loads.
  • The theme (Dark or Light).
  • The panels that should be minimized.
  • The version of the Solidity compiler & the optimize option enabled or disabled.

Activating a list of plugins

The following example contains the url parameter activate followed by a list of plugins. The last plugin will gain the focus.

When you use the activate list, all other plugins that a user had loaded will be deactivated. This does not apply to the file explorer, the plugin manager, and the settings modules because these are never deactivated.

https://remix.ethereum.org/?#activate=solidity,solidityUnitTesting,udapp,defiexplorer

Deactiving a list of plugins

https://remix.ethereum.org/?#deactivate=udapp

Note: a plugin is called by its name in its profile. To check for a plugin's profile name - for plugins built by external teams, please go to https://github.com/ethereum/remix-plugins-directory/tree/master/plugins

Minimizing Remix panels

The following URL will close everything except the main panel & the icon panel (the side and terminal are minimized).

https://remix.ethereum.org/?#embed=true

To minimize just the side panel, use this URL:

https://remix.ethereum.org/?#minimizesidepanel=true

To minimize just the terminal, use this URL:

https://remix.ethereum.org/?#minimizeterminal=true

Specifying a theme

To link to Remix with a theme specified use this url:

 **https://remix.ethereum.org/?#theme=Dark**

A URL example combining multiple parameters

To link to Remix with the a list of plugins activated and with:

  • the Learneth gaining the side panel's focus (because it is the last in the list)
  • the Light theme loaded
  • the terminal minimized
  • optimize off

use this url:

 https://remix.ethereum.org/?#activate=solidity,solidityUnitTesting,LearnEth&theme=Light&minimizeterminal=true&optimize=false&evmVersion=null&version=soljson-v0.6.6+commit.6c089d02.js

Pass commands to a plugin's API via a url param

The URL parameter to issue a command is call. Following the call is a // (double slash) separated list of arguments.

call=plugin_name//function//parameter1//paremeter2

An example using call

The URL below uses activate & call. It activates a number of plugins and calls the File Explorers to tell it to load one of the default Remix files:

https://remix.ethereum.org/?#activate=udapp,solidity&call=fileManager//open//3_Ballot.sol

Load a specific tutorial in the LearnEth plugin:

https://remix.ethereum.org/?#activate=udapp,solidity,LearnEth&call=LearnEth//startTutorial//ethereum/remix-workshops//master//proxycontract

Load a GIST

The URL parameter here is gist.

https://remix.ethereum.org/?gist=0fe90e825327ef313c88aedfe66ec142

Load a GIST and have it be visible in the Editor:

Using both gist & call

https://remix.ethereum.org/?#activate=solidity,udapp&gist=0fe90e825327ef313c88aedfe66ec142&call=fileManager//open//browser/gists/0fe90e825327ef313c88aedfe66ec142/gridMix4.sol

Load a GIST, have it be visible in the Editor & load a list of plugins:

https://remix.ethereum.org/?#activate=solidity,udapp&gist=0fe90e825327ef313c88aedfe66ec142&call=fileManager//open//browser/gists/0fe90e825327ef313c88aedfe66ec142/gridMix4.sol

Load a specific version of the Solidity compiler:

https://remix.ethereum.org/?#version=soljson-v0.6.6+commit.6c089d02

Note: you need to specify both the Solidity version and the commit.

Load a custom Solidity compiler:

https://remix.ethereum.org/#version=https://solidity-blog.s3.eu-central-1.amazonaws.com/data/08preview/soljson.js

Load an encoded base64 string into a .sol file

The code parameter takes an encoded base64 string and loads it the Editor as a .sol file and saves to the code-sample workspace of the File Explorer:

https://remix.ethereum.org/?#code=Ly8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IE1JVAoKcHJhZ21hIHNvbGlkaXR5IDAuOC40OwoKLyoqCiAqIEB0aXRsZSBXb25kZXJmdWxDb2RlCiAqIEBkZXYgV2VsY29tZSB0byBSZW1peAogKi8KY29udHJhY3QgWW91IHsKCiAgICBhZGRyZXNzIHByaXZhdGUgb3duZXI7CiAgICAKICAgIC8qKgogICAgICogQGRldiBTZXQgY29udHJhY3QgZGVwbG95ZXIgYXMgeW91QW5kWW91cldvbmRlcmZ1bFNlbGYKICAgICAqLwogICAgY29uc3RydWN0b3IoKSB7CiAgICAgICAgeW91QW5kWW91cldvbmRlcmZ1bFNlbGYgPSBtc2cuc2VuZGVyOwoKICAgIH0KCiAgICAvKioKICAgICAqIEBkZXYgQ2hhbmdlIG1vb2QKICAgICAqIEBwYXJhbSBuZXdPd25lciBhZGRyZXNzIG9mIG5ldyBvd25lcgogICAgICovCiAgICBmdW5jdGlvbiBjaGFuZ2VNb29kKGFkZHJlc3MgbmV3TW9vZEFkZHIpIHB1YmxpYyB7CiAgICAgICAgb3duZXJNb29kID0gbmV3TW9vZEFkZHI7CiAgICB9Cn0=