remix-project mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
yann300 26cad8934c fix tests 8 years ago
assets use font-awesome.css for button 8 years ago
ci Update deploy_from_travis.sh 8 years ago
docs Merge pull request #207 from ethereum/tuto3 8 years ago
src fix locals 8 years ago
test fix tests 8 years ago
test-browser fix tests 8 years ago
.gitignore gitignore built doc 8 years ago
.npmignore Add travis config. 9 years ago
.travis.yml remove cache 8 years ago
LICENSE Initial commit 9 years ago
README.md RE-ADD previously reverted build process improvements & refactorings 8 years ago
findClient.js startnode script 8 years ago
index.html use font-awesome.css for button 8 years ago
nightwatch.js change test platform (same as browser sol) 8 years ago
package.json RE-ADD previously reverted build process improvements & refactorings 8 years ago
runNode.sh startnode script 8 years ago

README.md

REMIX

Join the chat at https://gitter.im/ethereum/remix Ethereum IDE and tools for the web

REMIX WEBSITE:

Remix is avalaible at http://ethereum.github.io/remix. You can use it either inside Mist or by connecting to geth or eth. Note that connecting to Geth does not work through https.

You'll have to run your own node using the following parameters:

DO NOT DO THIS IF geth/eth STORES PRIVATE KEYS External system might be able to access your node through the RPC server.

Using Geth:

geth --rpc --rpcapi 'web3,eth,debug' --rpcport 8545 --rpccorsdomain '*'

Using Eth:

eth -j --rpccorsdomain '*'

geth will run the rpc server on http://localhost:8545, remix uses by default this url.

Remix will use this instance of Geth to retrieve the transaction and the associated trace. This instance should only be used for debugging purposes. Never use features that could have an impact on your keys (do not unlock any keys, do not use this instance together with the wallet, do not activate the admin web3 API).

INSTALLATION:

Brief instructions to build for linux(Todo add other platforms) we will add detailed instructions later

Install eth or geth, npm and node.js (see https://docs.npmjs.com/getting-started/installing-node), then do:

* `git clone https://github.com/ethereum/remix`
* `cd remix`
* `npm install`
* `npm start`

open remix/index.html in your browser.

TEST:

  • For unit tests run npm test

  • For local headless browser tests

    • run once to install selenium: npm run selenium-install
    • every time you want to run local browser tests, run: npm run test-browser

DEVELOPING:

Run npm run start_dev and open http://127.0.0.1:8080 in your browser.

Start developing and see your browser live reload when you save files

REMIX First Step:

Once remix is connected to a node, you will be able to debug transactions. There's two way of doing that:

  • using a block number and a transaction index.
  • using a transaction hash.

When loading the transaction succeed, the hash, from and to field will show up. Then the vm trace is loaded.

The debugger itself contains several controls that allow stepping over the trace and seing the current state of a selected step.

Slider and Stepping action:

The slider allows to move quickly from a state to another. Stepping actions are:

  • Step Into Back
  • Step Over Back
  • Step Over Forward
  • Step Into Forward
  • Jump Next Call (this will select the next state that refers to a context changes - CALL, CALLCODE, DELEGATECALL, CREATE)

State Viewer:

The upper right panel contains basic informations about the current step:

  • VMTraceStep: the index in the trace of the current step.
  • Step
  • Add memory
  • Gas: gas used by this step
  • Remaining gas: gas left
  • Loaded address: the current code loaded, refers to the executing code.

The other 6 panels describe the current selected state:

  • Instructions list: list of all the instruction that defines the current executing code.
  • Stack
  • Storage Changes
  • Memory
  • Call Data$
  • Call Stack

CODING STYLE:

Remix uses npm coding style: https://docs.npmjs.com/misc/coding-style Please be sure your code is compliant with this coding standard before sending PR. There's on the above page a bunch of links that propose integration with developer tools (Emacs, Atom, ...). You can also run 'npm run test' to check your local repository against the coding style.