U.M Andrew
3 years ago
committed by
GitHub
commit
e3e69471a9
@ -1,4 +0,0 @@ |
||||
# Add files here to ignore them from prettier formatting |
||||
|
||||
/dist |
||||
/coverage |
||||
@ -1,3 +0,0 @@ |
||||
{ |
||||
"singleQuote": true |
||||
} |
||||
@ -0,0 +1,18 @@ |
||||
import { NightwatchBrowser } from 'nightwatch' |
||||
import EventEmitter from 'events' |
||||
|
||||
class switchEnvironment extends EventEmitter { |
||||
command (this: NightwatchBrowser, provider: string): NightwatchBrowser { |
||||
this.api.waitForElementVisible('[data-id="settingsSelectEnvOptions"]') |
||||
.click('[data-id="settingsSelectEnvOptions"] button') |
||||
.waitForElementVisible(`[data-id="dropdown-item-${provider}"]`) |
||||
.click(`[data-id="dropdown-item-${provider}"]`) |
||||
.perform((done) => { |
||||
done() |
||||
this.emit('complete') |
||||
}) |
||||
return this |
||||
} |
||||
} |
||||
|
||||
module.exports = switchEnvironment |
||||
@ -0,0 +1,18 @@ |
||||
import { NightwatchBrowser } from 'nightwatch' |
||||
import EventEmitter from 'events' |
||||
|
||||
class switchWorkspace extends EventEmitter { |
||||
command (this: NightwatchBrowser, workspaceName: string): NightwatchBrowser { |
||||
this.api.waitForElementVisible('[data-id="workspacesSelect"]') |
||||
.click('[data-id="workspacesSelect"]') |
||||
.waitForElementVisible(`[data-id="dropdown-item-${workspaceName}"]`) |
||||
.click(`[data-id="dropdown-item-${workspaceName}"]`) |
||||
.perform((done) => { |
||||
done() |
||||
this.emit('complete') |
||||
}) |
||||
return this |
||||
} |
||||
} |
||||
|
||||
module.exports = switchWorkspace |
||||
@ -0,0 +1,287 @@ |
||||
'use strict' |
||||
import { NightwatchBrowser } from 'nightwatch' |
||||
import init from '../helpers/init' |
||||
|
||||
let firstProxyAddress: string |
||||
let lastProxyAddress: string |
||||
module.exports = { |
||||
before: function (browser: NightwatchBrowser, done: VoidFunction) { |
||||
init(browser, done) |
||||
}, |
||||
|
||||
'@sources': function () { |
||||
return sources |
||||
}, |
||||
|
||||
'Should show deploy proxy option for UUPS upgradeable contract': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.addFile('myTokenV1.sol', sources[0]['myTokenV1.sol']) |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyToken]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyToken]') |
||||
.waitForElementPresent('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.waitForElementPresent('[data-id="contractGUIUpgradeImplementationLabel"]') |
||||
}, |
||||
|
||||
'Should show upgrade proxy option for child contract inheriting UUPS parent contract': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.addFile('myTokenV2.sol', sources[1]['myTokenV2.sol']) |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyTokenV2]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyTokenV2]') |
||||
.waitForElementPresent('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.waitForElementPresent('[data-id="contractGUIUpgradeImplementationLabel"]') |
||||
}, |
||||
|
||||
'Should deploy proxy without initialize parameters': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.openFile('myTokenV1.sol') |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyToken]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyToken]') |
||||
.waitForElementPresent('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.click('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.createContract('') |
||||
.waitForElementContainsText('[data-id="udappNotifyModalDialogModalTitle-react"]', 'Deploy Implementation & Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.click('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.waitForElementContainsText('[data-id="confirmProxyDeploymentModalDialogModalTitle-react"]', 'Confirm Deploy Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.click('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander0"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander1"]') |
||||
}, |
||||
|
||||
'Should interact with deployed contract via ERC1967 (proxy)': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.getAddressAtPosition(1, (address) => { |
||||
firstProxyAddress = address |
||||
}) |
||||
.clickInstance(1) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(firstProxyAddress, 'name - call', null, '0:\nstring: MyToken').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(firstProxyAddress, 'symbol - call', null, '0:\nstring: MTK').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
}, |
||||
|
||||
'Should deploy proxy with initialize parameters': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.waitForElementPresent('[data-id="deployAndRunClearInstances"]') |
||||
.click('[data-id="deployAndRunClearInstances"]') |
||||
.addFile('initializeProxy.sol', sources[2]['initializeProxy.sol']) |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyInitializedToken]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyInitializedToken]') |
||||
.waitForElementPresent('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.click('[data-id="contractGUIDeployWithProxyLabel"]') |
||||
.waitForElementPresent('input[title="tokenName"]') |
||||
.waitForElementPresent('input[title="tokenSymbol"]') |
||||
.setValue('input[title="tokenName"]', 'Remix') |
||||
.setValue('input[title="tokenSymbol"]', "R") |
||||
.createContract('') |
||||
.waitForElementContainsText('[data-id="udappNotifyModalDialogModalTitle-react"]', 'Deploy Implementation & Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.click('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.waitForElementContainsText('[data-id="confirmProxyDeploymentModalDialogModalTitle-react"]', 'Confirm Deploy Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.click('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander0"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander1"]') |
||||
}, |
||||
|
||||
'Should interact with initialized contract to verify parameters': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.getAddressAtPosition(1, (address) => { |
||||
lastProxyAddress = address |
||||
}) |
||||
.clickInstance(1) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(lastProxyAddress, 'name - call', null, '0:\nstring: Remix').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(lastProxyAddress, 'symbol - call', null, '0:\nstring: R').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
}, |
||||
|
||||
'Should upgrade contract using last deployed proxy address (MyTokenV1 to MyTokenV2)': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.waitForElementPresent('[data-id="deployAndRunClearInstances"]') |
||||
.click('[data-id="deployAndRunClearInstances"]') |
||||
.openFile('myTokenV2.sol') |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyTokenV2]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyTokenV2]') |
||||
.waitForElementPresent('[data-id="contractGUIUpgradeImplementationLabel"]') |
||||
.click('[data-id="contractGUIUpgradeImplementationLabel"]') |
||||
.waitForElementPresent('[data-id="contractGUIProxyAddressLabel"]') |
||||
.click('[data-id="contractGUIProxyAddressLabel"]') |
||||
.waitForElementPresent('[data-id="lastDeployedERC1967Address"]') |
||||
.assert.containsText('[data-id="lastDeployedERC1967Address"]', lastProxyAddress) |
||||
.createContract('') |
||||
.waitForElementContainsText('[data-id="udappNotifyModalDialogModalTitle-react"]', 'Deploy Implementation & Update Proxy') |
||||
.waitForElementVisible('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.click('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.waitForElementContainsText('[data-id="confirmProxyDeploymentModalDialogModalTitle-react"]', 'Confirm Update Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.click('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander0"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander1"]') |
||||
}, |
||||
|
||||
'Should interact with upgraded function in contract MyTokenV2': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.clickInstance(1) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(lastProxyAddress, 'version - call', null, '0:\nstring: MyTokenV2!').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
}, |
||||
|
||||
'Should upgrade contract by providing proxy address in input field (MyTokenV1 to MyTokenV2)': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.waitForElementPresent('[data-id="deployAndRunClearInstances"]') |
||||
.click('[data-id="deployAndRunClearInstances"]') |
||||
.openFile('myTokenV2.sol') |
||||
.clickLaunchIcon('solidity') |
||||
.pause(2000) |
||||
.click('[data-id="compilerContainerCompileBtn"]') |
||||
.waitForElementPresent('select[id="compiledContracts"] option[value=MyTokenV2]', 60000) |
||||
.clickLaunchIcon('udapp') |
||||
.click('select.udapp_contractNames') |
||||
.click('select.udapp_contractNames option[value=MyTokenV2]') |
||||
.waitForElementPresent('[data-id="contractGUIUpgradeImplementationLabel"]') |
||||
.waitForElementPresent('[data-id="contractGUIProxyAddressLabel"]') |
||||
.click('[data-id="contractGUIProxyAddressLabel"]') |
||||
.waitForElementPresent('[data-id="ERC1967AddressInput"]') |
||||
.setValue('[data-id="ERC1967AddressInput"]', firstProxyAddress) |
||||
.createContract('') |
||||
.waitForElementContainsText('[data-id="udappNotifyModalDialogModalTitle-react"]', 'Deploy Implementation & Update Proxy') |
||||
.waitForElementVisible('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.click('[data-id="udappNotify-modal-footer-ok-react"]') |
||||
.waitForElementContainsText('[data-id="confirmProxyDeploymentModalDialogModalTitle-react"]', 'Confirm Update Proxy (ERC1967)') |
||||
.waitForElementVisible('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.click('[data-id="confirmProxyDeployment-modal-footer-ok-react"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander0"]') |
||||
.waitForElementPresent('[data-id="universalDappUiTitleExpander1"]') |
||||
}, |
||||
|
||||
'Should interact with upgraded contract through provided proxy address': function (browser: NightwatchBrowser) { |
||||
browser |
||||
.clickInstance(1) |
||||
.perform((done) => { |
||||
browser.testConstantFunction(firstProxyAddress, 'version - call', null, '0:\nstring: MyTokenV2!').perform(() => { |
||||
done() |
||||
}) |
||||
}) |
||||
.end() |
||||
} |
||||
} |
||||
|
||||
const sources = [ |
||||
{ |
||||
'myTokenV1.sol': { |
||||
content: ` |
||||
// SPDX-License-Identifier: MIT
|
||||
pragma solidity ^0.8.4; |
||||
|
||||
import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol"; |
||||
|
||||
contract MyToken is Initializable, ERC721Upgradeable, OwnableUpgradeable, UUPSUpgradeable { |
||||
/// @custom:oz-upgrades-unsafe-allow constructor
|
||||
constructor() { |
||||
_disableInitializers(); |
||||
} |
||||
|
||||
function initialize() initializer public { |
||||
__ERC721_init("MyToken", "MTK"); |
||||
__Ownable_init(); |
||||
__UUPSUpgradeable_init(); |
||||
} |
||||
|
||||
function _authorizeUpgrade(address newImplementation) |
||||
internal |
||||
onlyOwner |
||||
override |
||||
{} |
||||
} |
||||
` |
||||
} |
||||
}, { |
||||
'myTokenV2.sol': { |
||||
content: ` |
||||
import "./myTokenV1.sol"; |
||||
|
||||
contract MyTokenV2 is MyToken { |
||||
function version () public view returns (string memory) { |
||||
return "MyTokenV2!"; |
||||
} |
||||
} |
||||
` |
||||
} |
||||
}, { |
||||
'initializeProxy.sol': { |
||||
content: ` |
||||
// SPDX-License-Identifier: MIT
|
||||
pragma solidity ^0.8.4; |
||||
|
||||
import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; |
||||
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol"; |
||||
|
||||
contract MyInitializedToken is Initializable, ERC721Upgradeable, OwnableUpgradeable, UUPSUpgradeable { |
||||
/// @custom:oz-upgrades-unsafe-allow constructor
|
||||
constructor() { |
||||
_disableInitializers(); |
||||
} |
||||
|
||||
function initialize(string memory tokenName, string memory tokenSymbol) initializer public { |
||||
__ERC721_init(tokenName, tokenSymbol); |
||||
__Ownable_init(); |
||||
__UUPSUpgradeable_init(); |
||||
} |
||||
|
||||
function _authorizeUpgrade(address newImplementation) |
||||
internal |
||||
onlyOwner |
||||
override |
||||
{} |
||||
} |
||||
` |
||||
} |
||||
} |
||||
] |
||||
@ -1,174 +0,0 @@ |
||||
[](https://circleci.com/gh/ethereum/remix-project) |
||||
|
||||
# Remix |
||||
|
||||
Remix is a browser-based compiler and IDE that enables users to build **Ethereum contracts with Solidity language** and to debug transactions. |
||||
|
||||
To try it out, visit [https://remix.ethereum.org](https://remix.ethereum.org). |
||||
|
||||
https://github.com/ethereum/remix-ide/releases also gives others ways to use Remix locally. Please check it out. |
||||
|
||||
Remix consists of many modules and in this repository you will find the Remix IDE (aka. Browser-Solidity). |
||||
|
||||
 |
||||
|
||||
## Offline Usage |
||||
|
||||
The `gh-pages` branch has always the latest stable build of Remix. It also contains a ZIP file with the entire build. Download it to use offline. |
||||
|
||||
Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported. |
||||
|
||||
|
||||
## INSTALLATION: |
||||
|
||||
Install **npm** and **node.js** (see https://docs.npmjs.com/getting-started/installing-node), then do: |
||||
|
||||
Remix-ide has been published as an npm module: |
||||
|
||||
```bash |
||||
yarn global add remix-ide |
||||
remix-ide |
||||
``` |
||||
Or if you want to clone the github repository (`wget` need to be installed first) : |
||||
|
||||
```bash |
||||
git clone https://github.com/ethereum/remix-ide.git |
||||
git clone https://github.com/ethereum/remix.git # only if you plan to link remix and remix-ide repositories and develop on it. |
||||
|
||||
cd remix # only if you plan to link remix and remix-ide repositories and develop on it. |
||||
yarn install # only if you plan to link remix and remix-ide repositories and develop on it. |
||||
yarn run bootstrap # only if you plan to link remix and remix-ide repositories and develop on it. |
||||
|
||||
cd remix-ide |
||||
yarn install |
||||
yarn run setupremix # only if you plan to link remix and remix-ide repositories and develop on it. |
||||
npm start |
||||
``` |
||||
|
||||
## Docker: |
||||
|
||||
Prerequisites: |
||||
* Docker (https://docs.docker.com/desktop/) |
||||
* Docker-compose (https://docs.docker.com/compose/install/) |
||||
|
||||
### Run with docker |
||||
|
||||
If you want to run latest changes that are merged into master branch then run: |
||||
|
||||
``` |
||||
docker pull remixproject/remix-ide:latest |
||||
docker run -p 8080:80 remixproject/remix-ide:latest |
||||
``` |
||||
|
||||
If you want to run latest remix-live release run. |
||||
``` |
||||
docker pull remixproject/remix-ide:remix_live |
||||
docker run -p 8080:80 remixproject/remix-ide:remix_live |
||||
``` |
||||
|
||||
### Run with docker-compose: |
||||
|
||||
To run locally without building you only need docker-compose.yaml file and you can run: |
||||
|
||||
``` |
||||
docker-compose pull |
||||
docker-compose up -d |
||||
``` |
||||
|
||||
Then go to http://localhost:8080 and you can use you Remix instance. |
||||
|
||||
To fetch docker-compose file without cloning this repo run: |
||||
``` |
||||
curl https://raw.githubusercontent.com/ethereum/remix-ide/master/docker-compose.yaml > docker-compose.yaml |
||||
``` |
||||
|
||||
## DEVELOPING: |
||||
|
||||
Run `npm start` and open `http://127.0.0.1:8080` in your browser. |
||||
|
||||
Then open your `text editor` and start developing. |
||||
The browser will automatically refresh when files are saved. |
||||
|
||||
Most of the the time working with other modules (like debugger etc.) hosted in the [Remix repository](https://github.com/ethereum/remix) is not needed. |
||||
|
||||
### Troubleshooting building |
||||
|
||||
Some things to consider if you have trouble building the package: |
||||
|
||||
- Make sure that you have the correct version of `node`, `npm` and `nvm`. You can find the version that is tested on Travis CI by looking at the log in the [build results](https://travis-ci.org/ethereum/remix-ide). |
||||
|
||||
Run: |
||||
|
||||
```bash |
||||
node --version |
||||
npm --version |
||||
nvm --version |
||||
``` |
||||
|
||||
- In Debian based OS such as Ubuntu 14.04LTS you may need to run `apt-get install build-essential`. After installing `build-essential` run `npm rebuild`. |
||||
|
||||
## Unit Testing |
||||
|
||||
Register new unit test files in `test/index.js`. |
||||
The tests are written using [tape](https://www.npmjs.com/package/tape). |
||||
|
||||
Run the unit tests via: `yarn test` |
||||
|
||||
For local headless browser tests run `yarn run test-browser` |
||||
(requires Selenium to be installed - can be done with `yarn run selenium-install`) |
||||
|
||||
Running unit tests via `yarn test` requires at least node v7.0.0 |
||||
|
||||
## Browser Testing |
||||
|
||||
To run the Selenium tests via Nightwatch: |
||||
|
||||
- Build Remix IDE and serve it: `yarn run build && yarn run serve` # starts web server at localhost:8080 |
||||
- Make sure Selenium is installed `yarn run selenium-install` # don't need to repeat |
||||
- Run a selenium server `yarn run selenium` |
||||
- Run all the tests `yarn run nightwatch_local_firefox` or `yarn run nightwatch_local_chrome` |
||||
- Or run a specific test case: |
||||
|
||||
- yarn run nightwatch_local_ballot |
||||
|
||||
- yarn run nightwatch_local_libraryDeployment |
||||
|
||||
- yarn run nightwatch_local_solidityImport |
||||
|
||||
- yarn run nightwatch_local_recorder |
||||
|
||||
- yarn run nightwatch_local_transactionExecution |
||||
|
||||
- yarn run nightwatch_local_staticAnalysis |
||||
|
||||
- yarn run nightwatch_local_signingMessage |
||||
|
||||
- yarn run nightwatch_local_console |
||||
|
||||
- yarn run nightwatch_local_remixd # remixd needs to be run |
||||
**NOTE:** |
||||
|
||||
- **the `ballot` tests suite** requires to run `ganache-cli` locally. |
||||
|
||||
- **the `remixd` tests suite** requires to run `remixd` locally. |
||||
|
||||
- **the `gist` tests suite** requires specifying a github access token in **.env file**. |
||||
``` |
||||
gist_token = <token> |
||||
``` |
||||
**note that this token should have permission to create a gist.** |
||||
|
||||
|
||||
## Usage as a Chrome Extension |
||||
|
||||
If you would like to use this as a Chrome extension, you must either build it first or pull from the `gh-pages` branch, both described above. |
||||
After that, follow these steps: |
||||
|
||||
- Browse to `chrome://extensions/` |
||||
- Make sure 'Developer mode' has been checked |
||||
- Click 'Load unpacked extension...' to pop up a file-selection dialog |
||||
- Select your `remix-ide` folder |
||||
|
||||
## Documentation |
||||
|
||||
To see details about how to use Remix for developing and/or debugging Solidity contracts, please see [our documentation page](https://remix-ide.readthedocs.io/en/latest/) |
||||
@ -1,21 +0,0 @@ |
||||
#!/usr/bin/env node |
||||
var path = require('path') |
||||
var httpServer = require('http-server') |
||||
var remixd = require('remixd') |
||||
|
||||
var server = httpServer.createServer({ |
||||
root: path.join(__dirname, '/../') |
||||
}) |
||||
|
||||
var folder = process.argv.length > 2 ? process.argv[2] : process.cwd() |
||||
|
||||
server.listen(8080, '127.0.0.1', function () {}) |
||||
var router = new remixd.Router(65520, remixd.services.sharedFolder, { remixIdeUrl: 'http://localhost:8080' }, (webSocket) => { |
||||
remixd.services.sharedFolder.setWebSocket(webSocket) |
||||
remixd.services.sharedFolder.setupNotifications(folder) |
||||
remixd.services.sharedFolder.sharedFolder(folder, false) |
||||
}) |
||||
|
||||
router.start() |
||||
|
||||
console.log('\x1b[33m%s\x1b[0m', 'Starting Remix IDE at http://localhost:8080 and sharing ' + folder) |
||||
@ -1,87 +0,0 @@ |
||||
FAQ |
||||
=== |
||||
|
||||
### Solidity compiler |
||||
|
||||
**Q: Error: compiler might be in a non-sane state** |
||||
``` |
||||
error: "Uncaught JavaScript exception: RangeError: Maximum call stack size exceeded. |
||||
The compiler might be in a non-sane state, please be careful and do not use further compilation data to deploy to mainnet. |
||||
It is heavily recommended to use another browser not affected by this issue (Firefox is known to not be affected)." |
||||
``` |
||||
|
||||
**A:** Old versions of solidity compiler had this problem with chrome. |
||||
Please change the compiler version in Solidity Plugin to the newer one or use another browser. |
||||
|
||||
**Q:** I’m getting an issue with Maximum call stack exceed and various other errors, can't compile. |
||||
|
||||
**A:** Try a different browser or a newer solidity compiler version. |
||||
|
||||
**Q:** How to verify a contract that imports other contracts? |
||||
|
||||
**A:** The verification tool does not recursively go through the import statments in a contract. So can only verify a 'flattened' contract. |
||||
|
||||
There is a plugin called `Flattener` which will stuff all the original code and the imported code into a single file. |
||||
|
||||
### Deploy & Run |
||||
|
||||
**Q:** I am using an Infura endpoint in my app, but when I try to deploy against that endpoint in remix IDE selecting "web3 provider" and putting my endpoint in, it's telling me that it can't connect |
||||
|
||||
**A:** If the endpoint you are using is http, it won't work. |
||||
|
||||
**Q:** Where is deploy button? |
||||
|
||||
**A:** Its in the Deploy & Run module. If you haven't activated that module, you should do that by clicking Deploy & Run module in the Plugin Manager. |
||||
You could also activate everything you need to work with solidity on the landing page ( click the remix logo at the top left for the screen) and click the "Solidity" button in the environment section. |
||||
|
||||
**Q:** How to pass a tuple to a public function in Remix? |
||||
|
||||
**A:** Pass it as an array []. |
||||
|
||||
**Q:** How to input a struct as input to a parameter of a function in the Deploy & Run module? |
||||
|
||||
**A:** For inputting a struct, just like a tuple, pass it in as an array []. Also you need to put in the line: |
||||
|
||||
`pragma experimental ABIEncoderV2;` at the top of the solidity file. |
||||
|
||||
For example, here's a solidity file with a struct is an input parameter. |
||||
|
||||
``` |
||||
pragma solidity >=0.4.22 <0.6.0; |
||||
pragma experimental ABIEncoderV2; |
||||
|
||||
contract daPeeps { |
||||
struct Peep {uint a; uint b;} // declaration of Peep type |
||||
Peep peep; //declaration of an object of Peep type |
||||
|
||||
constructor () public |
||||
{ |
||||
peep.a = 0; // definition/initialisation of object |
||||
peep.b = 0; // |
||||
} |
||||
|
||||
function initPeepToPeep(Peep memory i) public payable { |
||||
peep.a = i.a; |
||||
peep.b = i.b; |
||||
} |
||||
function setPeep(uint a, uint b) public payable { |
||||
peep.a = a; |
||||
peep.b = b; |
||||
} |
||||
|
||||
function getPeep() public view returns(Peep memory) |
||||
{ |
||||
return peep; |
||||
} |
||||
} |
||||
``` |
||||
|
||||
The input of initPeepToPeeps takes a struct. If you input |
||||
`[1,2]` the transaction will go through. |
||||
|
||||
|
||||
### General |
||||
|
||||
**Q:** Where do plugin developers go with their questions? |
||||
|
||||
**A:** The Gitter Remix plugin developers room https://gitter.im/ethereum/remix-dev-plugin |
||||
@ -1,216 +0,0 @@ |
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
||||
endif |
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help |
||||
help: |
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
|
||||
.PHONY: clean |
||||
clean: |
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
.PHONY: html |
||||
html: |
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml |
||||
dirhtml: |
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml |
||||
singlehtml: |
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle |
||||
pickle: |
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json |
||||
json: |
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp |
||||
htmlhelp: |
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
.PHONY: qthelp |
||||
qthelp: |
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Remix.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Remix.qhc"
|
||||
|
||||
.PHONY: applehelp |
||||
applehelp: |
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
.PHONY: devhelp |
||||
devhelp: |
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/Remix"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Remix"
|
||||
@echo "# devhelp"
|
||||
|
||||
.PHONY: epub |
||||
epub: |
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: latex |
||||
latex: |
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
.PHONY: latexpdf |
||||
latexpdf: |
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: latexpdfja |
||||
latexpdfja: |
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: text |
||||
text: |
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
.PHONY: man |
||||
man: |
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo |
||||
texinfo: |
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
.PHONY: info |
||||
info: |
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
.PHONY: gettext |
||||
gettext: |
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes |
||||
changes: |
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck |
||||
linkcheck: |
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
.PHONY: doctest |
||||
doctest: |
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
.PHONY: coverage |
||||
coverage: |
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
.PHONY: xml |
||||
xml: |
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml |
||||
pseudoxml: |
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
@ -1,95 +0,0 @@ |
||||
Remix Assert Library |
||||
==================== |
||||
|
||||
* [Assert.ok(value[, message])](#assert-ok-value-message) |
||||
* [Assert.equal(actual, expected[, message])](#assert-equal-actual-expected-message) |
||||
* [Assert.notEqual(actual, expected[, message])](#assert-notequal-actual-expected-message) |
||||
* [Assert.greaterThan(value1, value2[, message])](#assert-greaterthan-value1-value2-message) |
||||
* [Assert.lesserThan(value1, value2[, message])](#assert-lesserthan-value1-value2-message) |
||||
|
||||
|
||||
## Assert |
||||
|
||||
### Assert.ok(value[, message]) |
||||
* `value`: \<bool\> |
||||
* `message`: \<string\> |
||||
|
||||
Tests if value is truthy. `message` is returned in case of failure. |
||||
|
||||
Examples: |
||||
``` |
||||
Assert.ok(true); |
||||
// OK |
||||
Assert.ok(false, "it\'s false"); |
||||
// error: it's false |
||||
``` |
||||
|
||||
### Assert.equal(actual, expected[, message]) |
||||
* `actual`: \<uint | int | bool | address | bytes32 | string\> |
||||
* `expected`: \<uint | int | bool | address | bytes32 | string\> |
||||
* `message`: \<string\> |
||||
|
||||
Tests if `actual` & `expected` values are same. `message` is returned in case of failure. |
||||
|
||||
Examples: |
||||
``` |
||||
Assert.equal(string("a"), "a"); |
||||
// OK |
||||
Assert.equal(uint(100), 100); |
||||
// OK |
||||
foo.set(200) |
||||
Assert.equal(foo.get(), 200); |
||||
// OK |
||||
Assert.equal(foo.get(), 100, "value should be 200"); |
||||
// error: value should be 200 |
||||
``` |
||||
|
||||
### Assert.notEqual(actual, expected[, message]) |
||||
* `actual`: \<uint | int | bool | address | bytes32 | string\> |
||||
* `expected`: \<uint | int | bool | address | bytes32 | string\> |
||||
* `message`: \<string\> |
||||
|
||||
Tests if `actual` & `expected` values are not same. `message` is returned in case of failure. |
||||
|
||||
Examples: |
||||
``` |
||||
Assert.notEqual(string("a"), "b"); |
||||
// OK |
||||
foo.set(200) |
||||
Assert.notEqual(foo.get(), 200, "value should not be 200"); |
||||
// error: value should not be 200 |
||||
``` |
||||
|
||||
### Assert.greaterThan(value1, value2[, message]) |
||||
* `value1`: \<uint | int\> |
||||
* `value2`: \<uint | int\> |
||||
* `message`: \<string\> |
||||
|
||||
Tests if `value1` is greater than `value2`. `message` is returned in case of failure. |
||||
|
||||
Examples: |
||||
``` |
||||
Assert.greaterThan(uint(2), uint(1)); |
||||
// OK |
||||
Assert.greaterThan(uint(-2), uint(1)); |
||||
// OK |
||||
Assert.greaterThan(int(2), int(1)); |
||||
// OK |
||||
Assert.greaterThan(int(-2), int(-1), "-2 is not greater than -1"); |
||||
// error: -2 is not greater than -1 |
||||
``` |
||||
|
||||
### Assert.lesserThan(value1, value2[, message]) |
||||
* `value1`: \<uint | int\> |
||||
* `value2`: \<uint | int\> |
||||
* `message`: \<string\> |
||||
|
||||
Tests if `value1` is lesser than `value2`. `message` is returned in case of failure. |
||||
|
||||
Examples: |
||||
``` |
||||
Assert.lesserThan(int(-2), int(-1)); |
||||
// OK |
||||
Assert.lesserThan(int(2), int(1), "2 is not lesser than 1"); |
||||
// error: 2 is not greater than 1 |
||||
``` |
||||
@ -1,11 +0,0 @@ |
||||
Code Contribution Guide |
||||
======================= |
||||
|
||||
Remix is an open source tool and we encourage anyone to help us improve our tool. |
||||
You can do that by opening issues, giving feedback or by contributing a pull request |
||||
to our codebase. |
||||
|
||||
The Remix application is built with JavaScript and React. |
||||
Check out the `package.json` files in the Remix submodules to learn more about the stack. |
||||
|
||||
To learn more, please visit our [GitHub page](https://github.com/ethereum/remix-ide). |
||||
@ -1,14 +0,0 @@ |
||||
Community Support |
||||
======================= |
||||
|
||||
We know that blockchain ecosystem is very new and that lots of information is scattered around the web. |
||||
That is why we created a community support channel where we and other users try to answer your questions if |
||||
you get stuck using Remix. Please, join [the community](https://gitter.im/ethereum/remix) and ask for help. |
||||
|
||||
For anyone who is interested in developing a custom plugin for Remix or who wants to contribute to the codebase, |
||||
we opened a [contributors' channel](https://gitter.im/ethereum/remix-dev) especially for developers working on Remix tools. |
||||
|
||||
We would kindly ask you to respect the space and to use it for |
||||
getting help with your work and the developers' channel for discussions related to working on Remix codebase. If you have |
||||
ideas for collaborations or you want to promote your project, try to find some more appropriate channels to do so. Or you can contact |
||||
the main contributors directly on Gitter or Twitter. |
||||
@ -1,34 +0,0 @@ |
||||
Compiler (Solidity) |
||||
=================== |
||||
|
||||
Clicking the Solidity icon in the icon panel brings you to the Solidty Compiler. |
||||
|
||||
Compiling is triggered when you click the compile button ( **D. in image below**). If you want the file to be compiled each time the file is saved or when another file is selected - check the auto compile checkbox ( **E. in image below**). |
||||
|
||||
Since the Solidity version `0.5.7`, it is possible to compile `Yul` files. Please read the ([solidity documentation about Yul](https://solidity.readthedocs.io/en/latest/yul.html)) which contain some code examples. |
||||
You can use the language dropdown ( **B. in image below**) to switch the language. **This dropdown list is only available for versions greater than or equal to `0.5.7`.** |
||||
|
||||
The fork selection dropdown list ( **C. in image below**) allows to compile code against a specific ethereum hard fork. |
||||
The `compiler default` corresponds to the default hard fork used by a specific version. Please go to "Compilation Details" ( **G. in image below**) in the settings of `Metadata` section to see the harfork name used for the current compilation. |
||||
|
||||
If the contract has a lot of dependencies it can take a while to compile - so you use autocompilation at your discretion. |
||||
|
||||
 |
||||
|
||||
After each compilation, a list is updated with all newly compiled |
||||
contracts. A compiled contract can be selected with the Contract pulldown menu ( **F. in the image**). Multiple contracts are compiled when one contract imports other contracts. Selecting a contract will show information about that one. |
||||
|
||||
When the "Compilation Details" button is clicked ( **G. in image**), a modal opens displaying detailed information about the current selected contract. |
||||
|
||||
For those writing your own custom solidity compiler, you can import that by clicking the **+** button (**X. in the image**) to open a modal where you can input the url of the compiler to be loaded. |
||||
|
||||
From the Solidity Compiler module you can also publish your contract to Swarm (only non |
||||
abstract contracts can be published) & IPFS. |
||||
|
||||
Published data notably contains the `abi` and the solidity source code. |
||||
|
||||
After a contract is published, you can find its metadata information |
||||
using the bzz URL located in the details modal dialog `SWARM LOCATION`. |
||||
|
||||
Compilation Errors and Warning are displayed below the contract section. |
||||
At each compilation, the static analysis tab builds a report. It is important to address reported issues even if the compiler doesn't complain. ([see more](static_analysis.html)) |
||||
@ -1,305 +0,0 @@ |
||||
# -*- coding: utf-8 -*- |
||||
# |
||||
# Remix documentation build configuration file, created by |
||||
# sphinx-quickstart on Mon Feb 20 12:16:16 2017. |
||||
# |
||||
# This file is execfile()d with the current directory set to its |
||||
# containing dir. |
||||
# |
||||
# Note that not all possible configuration values are present in this |
||||
# autogenerated file. |
||||
# |
||||
# All configuration values have a default; values that are commented out |
||||
# serve to show the default. |
||||
|
||||
import sys |
||||
import os |
||||
|
||||
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory, |
||||
# add these directories to sys.path here. If the directory is relative to the |
||||
# documentation root, use os.path.abspath to make it absolute, like shown here. |
||||
# sys.path.insert(0, os.path.abspath('.')) |
||||
|
||||
# -- General configuration ------------------------------------------------ |
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here. |
||||
#needs_sphinx = '1.0' |
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be |
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
||||
# ones. |
||||
extensions = ['recommonmark'] # required for sphinx v3.0.0 |
||||
|
||||
# Add any paths that contain templates here, relative to this directory. |
||||
templates_path = ['_templates'] |
||||
|
||||
# The suffix(es) of source filenames. |
||||
# You can specify multiple suffix as a list of string: |
||||
source_suffix = ['.rst', '.md'] |
||||
|
||||
|
||||
# The encoding of source files. |
||||
#source_encoding = 'utf-8-sig' |
||||
|
||||
# The master toctree document. |
||||
master_doc = 'index' |
||||
|
||||
# General information about the project. |
||||
project = u'Remix, Ethereum-IDE' |
||||
copyright = u'2019, Remix' |
||||
author = u'Remix team' |
||||
|
||||
github_doc_root = 'https://github.com/ethereum/remix/tree/master/docs/' |
||||
|
||||
# The version info for the project you're documenting, acts as replacement for |
||||
# |version| and |release|, also used in various other places throughout the |
||||
# built documents. |
||||
# |
||||
# The short X.Y version. |
||||
version = u'1' |
||||
# The full version, including alpha/beta/rc tags. |
||||
release = u'1' |
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation |
||||
# for a list of supported languages. |
||||
# |
||||
# This is also used if you do content translation via gettext catalogs. |
||||
# Usually you set "language" from the command line for these cases. |
||||
language = None |
||||
|
||||
# There are two options for replacing |today|: either, you set today to some |
||||
# non-false value, then it is used: |
||||
#today = '' |
||||
# Else, today_fmt is used as the format for a strftime call. |
||||
#today_fmt = '%B %d, %Y' |
||||
|
||||
# List of patterns, relative to source directory, that match files and |
||||
# directories to ignore when looking for source files. |
||||
exclude_patterns = ['_build'] |
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all |
||||
# documents. |
||||
#default_role = None |
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text. |
||||
#add_function_parentheses = True |
||||
|
||||
# If true, the current module name will be prepended to all description |
||||
# unit titles (such as .. function::). |
||||
#add_module_names = True |
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the |
||||
# output. They are ignored by default. |
||||
#show_authors = False |
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use. |
||||
pygments_style = 'sphinx' |
||||
|
||||
highlight_language = 'JavaScript' |
||||
|
||||
# A list of ignored prefixes for module index sorting. |
||||
#modindex_common_prefix = [] |
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents. |
||||
#keep_warnings = False |
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing. |
||||
todo_include_todos = False |
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------- |
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for |
||||
# a list of builtin themes. |
||||
html_theme = 'sphinx_rtd_theme' |
||||
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme |
||||
# further. For a list of options available for each theme, see the |
||||
# documentation. |
||||
#html_theme_options = {} |
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory. |
||||
#html_theme_path = [] |
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to |
||||
# "<project> v<release> documentation". |
||||
#html_title = None |
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title. |
||||
#html_short_title = None |
||||
|
||||
# The name of an image file (relative to this directory) to place at the top |
||||
# of the sidebar. |
||||
#html_logo = None |
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of |
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
||||
# pixels large. |
||||
#html_favicon = None |
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here, |
||||
# relative to this directory. They are copied after the builtin static files, |
||||
# so a file named "default.css" will overwrite the builtin "default.css". |
||||
html_static_path = ['_static'] |
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or |
||||
# .htaccess) here, relative to this directory. These files are copied |
||||
# directly to the root of the documentation. |
||||
#html_extra_path = [] |
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
||||
# using the given strftime format. |
||||
#html_last_updated_fmt = '%b %d, %Y' |
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to |
||||
# typographically correct entities. |
||||
#html_use_smartypants = True |
||||
|
||||
# Custom sidebar templates, maps document names to template names. |
||||
#html_sidebars = {} |
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to |
||||
# template names. |
||||
#html_additional_pages = {} |
||||
|
||||
# If false, no module index is generated. |
||||
#html_domain_indices = True |
||||
|
||||
# If false, no index is generated. |
||||
#html_use_index = True |
||||
|
||||
# If true, the index is split into individual pages for each letter. |
||||
#html_split_index = False |
||||
|
||||
# If true, links to the reST sources are added to the pages. |
||||
#html_show_sourcelink = True |
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
||||
#html_show_sphinx = True |
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
||||
#html_show_copyright = True |
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will |
||||
# contain a <link> tag referring to it. The value of this option must be the |
||||
# base URL from which the finished HTML is served. |
||||
#html_use_opensearch = '' |
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
||||
#html_file_suffix = None |
||||
|
||||
# Language to be used for generating the HTML full-text search index. |
||||
# Sphinx supports the following languages: |
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
||||
#html_search_language = 'en' |
||||
|
||||
# A dictionary with options for the search language support, empty by default. |
||||
# Now only 'ja' uses this config value |
||||
#html_search_options = {'type': 'default'} |
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that |
||||
# implements a search results scorer. If empty, the default will be used. |
||||
#html_search_scorer = 'scorer.js' |
||||
|
||||
# Output file base name for HTML help builder. |
||||
htmlhelp_basename = 'Remixdoc' |
||||
|
||||
# -- Options for LaTeX output --------------------------------------------- |
||||
|
||||
latex_elements = { |
||||
# The paper size ('letterpaper' or 'a4paper'). |
||||
#'papersize': 'letterpaper', |
||||
|
||||
# The font size ('10pt', '11pt' or '12pt'). |
||||
#'pointsize': '10pt', |
||||
|
||||
# Additional stuff for the LaTeX preamble. |
||||
#'preamble': '', |
||||
|
||||
# Latex figure (float) alignment |
||||
#'figure_align': 'htbp', |
||||
} |
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples |
||||
# (source start file, target name, title, |
||||
# author, documentclass [howto, manual, or own class]). |
||||
latex_documents = [ |
||||
(master_doc, 'Remix.tex', u'Remix Documentation', |
||||
u'yann300', 'manual'), |
||||
] |
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of |
||||
# the title page. |
||||
#latex_logo = None |
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts, |
||||
# not chapters. |
||||
#latex_use_parts = False |
||||
|
||||
# If true, show page references after internal links. |
||||
#latex_show_pagerefs = False |
||||
|
||||
# If true, show URL addresses after external links. |
||||
#latex_show_urls = False |
||||
|
||||
# Documents to append as an appendix to all manuals. |
||||
#latex_appendices = [] |
||||
|
||||
# If false, no module index is generated. |
||||
#latex_domain_indices = True |
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------- |
||||
|
||||
# One entry per manual page. List of tuples |
||||
# (source start file, name, description, authors, manual section). |
||||
man_pages = [ |
||||
(master_doc, 'remix', u'Remix Documentation', |
||||
[author], 1) |
||||
] |
||||
|
||||
# If true, show URL addresses after external links. |
||||
#man_show_urls = False |
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------- |
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples |
||||
# (source start file, target name, title, author, |
||||
# dir menu entry, description, category) |
||||
texinfo_documents = [ |
||||
(master_doc, 'Remix', u'Remix Documentation', |
||||
author, 'Remix', 'One line description of project.', |
||||
'Miscellaneous'), |
||||
] |
||||
|
||||
# Documents to append as an appendix to all manuals. |
||||
#texinfo_appendices = [] |
||||
|
||||
# If false, no module index is generated. |
||||
#texinfo_domain_indices = True |
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
||||
#texinfo_show_urls = 'footnote' |
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu. |
||||
#texinfo_no_detailmenu = False |
||||
|
||||
# Uncomment these two lines with sphinx version 1.0.0 |
||||
# from recommonmark.parser import CommonMarkParser |
||||
# source_parsers = {'.md': CommonMarkParser} |
||||
|
||||
|
||||
# app setup hook |
||||
# def setup(app): |
||||
# app.add_config_value('recommonmark_config', { |
||||
# 'url_resolver': lambda url: github_doc_root + url, |
||||
# 'enable_auto_toc_tree': True, |
||||
# 'enable_eval_rst': True, |
||||
# 'enable_auto_doc_ref': True, |
||||
# }, True) |
||||
# app.add_transform(AutoStructify) |
||||
File diff suppressed because one or more lines are too long
@ -1,107 +0,0 @@ |
||||
Creating and Deploying a Contract |
||||
================================ |
||||
|
||||
There are 3 type of environments Remix can be plugged to: |
||||
`Javascript VM`, `Injected provider`, or `Web3 provider`. (for details see [Running transactions](https://remix-ide.readthedocs.io/en/latest/run.html)) |
||||
|
||||
Both `Web3 provider` and `Injected provider` require the use of an |
||||
external tool. |
||||
|
||||
The external tool for `Web3 provider` is an Ethereum node and for |
||||
`Injected provider` Metamask. |
||||
|
||||
The `JavaScript VM` mode is convenient because each execution runs in |
||||
your browser and you don't need any other software or Ethereum node to run it. |
||||
|
||||
So, it is the easiest test environment - **no setup required!** |
||||
|
||||
But keep in mind that reloading the browser when you are in the Javascript VM will restart Remix in an empty state. |
||||
|
||||
For performance purposes ( which is to say - for testing in an environment that is closest to the mainnet), it might also be better to use an external node. |
||||
|
||||
Selecting the VM mode |
||||
--------------------- |
||||
|
||||
Make sure the VM mode is selected. All accounts displayed in `Accounts` |
||||
should have 100 ether. |
||||
|
||||
Sample contract |
||||
--------------- |
||||
|
||||
``` |
||||
pragma solidity ^0.5.1; |
||||
|
||||
contract testContract { |
||||
|
||||
uint value; |
||||
|
||||
constructor (uint _p) public { |
||||
value = _p; |
||||
} |
||||
|
||||
function setP(uint _n) payable public { |
||||
value = _n; |
||||
} |
||||
|
||||
function setNP(uint _n) public { |
||||
value = _n; |
||||
} |
||||
|
||||
function get () view public returns (uint) { |
||||
return value; |
||||
} |
||||
} |
||||
|
||||
``` |
||||
|
||||
This contract is very basic. The goal is to quickly start to create and |
||||
to interact with a sample contract. |
||||
|
||||
Deploying an instance |
||||
--------------------- |
||||
|
||||
The `Compile tab` displays information related to the current contract |
||||
(note that there can be more than one) ([see compile](compile.html)). |
||||
|
||||
Moving on, in the `Run tab` select, `JavaScript VM` to specify that you |
||||
are going to deploy an instance of the contract in the `JavaScript VM` |
||||
state. |
||||
|
||||
 |
||||
|
||||
The constructor of `Ballot.sol` needs a parameter (of type `uint8`). |
||||
Give any value and click on `Deploy`. |
||||
|
||||
The transaction which deploys the instance of `Ballot` is created. |
||||
|
||||
In a "normal" blockchain, it can take several seconds to execute. This |
||||
is the time for the transaction to be mined. However, because we are |
||||
using the `JavaScript VM`, our execution is immediate. |
||||
|
||||
The terminal will inform you about the transaction. You can see details |
||||
there and start debugging. |
||||
|
||||
The newly created instance is displayed in the `run tab`. |
||||
|
||||
 |
||||
|
||||
Interacting with an instance |
||||
---------------------------- |
||||
|
||||
This new instance contains 3 actions which corresponds to the 3 |
||||
functions (`setP`, `setPN`, `get`). Clicking on `SetP` or `SetPN` will |
||||
create a new transaction. |
||||
|
||||
Note that `SetP` is `payable` (red button) : it is possible to send |
||||
value (Ether) to the contract. |
||||
|
||||
`SetPN` is not payable (orange button - depending on the theme) : it is not possible to send |
||||
value (Ether) to the contract. |
||||
|
||||
Clicking on `get` will not execute a transaction (usually its a blue button - depending on the theme). It doesn't execute a transaction because a `get` does not modify the state (variable |
||||
`value`) of this instance. |
||||
|
||||
As `get` is `view` you can see the return value just below the |
||||
action. |
||||
|
||||
 |
||||
@ -1,14 +0,0 @@ |
||||
Debugger |
||||
======== |
||||
|
||||
This module allows you to debug the transaction. It can be used to |
||||
deploy transactions created from Remix and already mined transactions. |
||||
(debugging works only if the current environment provides the necessary |
||||
features). |
||||
|
||||
To get to the debugger - you can click the debug button in the terminal when a successful or failed transaction appears there. You can also load the module from the plugin manager and then click the bug in the icon panel. Or you can get to the debugger by running the debug command in the console. |
||||
|
||||
|
||||
 |
||||
|
||||
To learn more about how to use this tool go to the [debugger tutorial](tutorial_debug.html). |
||||
@ -1,59 +0,0 @@ |
||||
File Explorers |
||||
============= |
||||
|
||||
To get to the File Explorers module - click the file explorers icon. |
||||
|
||||
 |
||||
|
||||
The basic files explorer lists all the files stored in your browser's **browser storage**. |
||||
You can see them in the **browser** folder. |
||||
|
||||
**Important Note:** Clearing the browser storage will **permanently delete** all the |
||||
solidity files stored there. This is an inherent limitation of a browser-based IDE. However, if you want to store files outside of the browser and on your computer's filesystem, use [Remixd](remixd.html) or use the [desktop version of Remix-IDE](https://github.com/ethereum/remix-desktop/releases/). RemixD enables you to have access to a selected folder on your hard drive. Remix Desktop is a version of Remix-IDE in an Electron app. |
||||
|
||||
You can rename, remove or |
||||
add new files to the file explorer. |
||||
|
||||
 |
||||
|
||||
We will start by reviewing the icons in the image above. |
||||
|
||||
The book icon - **A.** is the link to the module's documentation. |
||||
|
||||
The icons to the right of the **browser** file explorer in the image above only appear for browser storage. |
||||
|
||||
Create new File |
||||
--------------- |
||||
|
||||
The icon marked **B.** above. Creates a new file. |
||||
|
||||
Publish to Gist |
||||
--------------- |
||||
|
||||
The icon marked **C.** above. Publishes all files from the browser folder to a gist. Only file in the root of **browser** will be published. Files in subfolders will not be publish to the Gist. |
||||
Gist API has changed in 2018 and **requires** users to be authenticated to be able to publish a gist. |
||||
|
||||
Click [this link](https://github.com/settings/tokens) to GitHub tokens setup and select Generate new token. Then check the **Create gists** checkbox and generate a new token. |
||||
|
||||
Take the token and paste it in Remix's **Settings** module in the **GitHub Access Token** section. And then click Save. Now you should be able to use the feature. |
||||
|
||||
Create a folder |
||||
--------------- |
||||
|
||||
The icon marked **D.** above. Creates a new folder in **browser** file explorer. |
||||
|
||||
Context Menu (Right Click) |
||||
----------------------------- |
||||
Right click on a file or a folder and the **context menu** will appear. |
||||
|
||||
 |
||||
|
||||
You can rename or delete a selected file or a folder. You can also create a folder. |
||||
|
||||
To create a file with the context menu, right click on a folder to get the **Create File** option. A file will be created inside that folder. |
||||
|
||||
 |
||||
|
||||
The functionality of the context menu also works with RemixD (which gives you have access to a folder on your hard drive). |
||||
|
||||
**Note:** When working with RemixD, you need to open and close the **localhost** folder to refresh the view. |
||||
|
Before Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 4.7 KiB |
|
Before Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 9.6 KiB |
|
Before Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 7.7 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 196 KiB |
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 5.0 KiB |
|
Before Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 169 KiB |
|
Before Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 8.8 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 1.0 KiB |
@ -1,74 +0,0 @@ |
||||
Importing Source Files in Solidity |
||||
================================== |
||||
|
||||
There are multiple techniques for importing files into Remix. |
||||
|
||||
For a tutorial about importing files click [here](https://github.com/ethereum/remix-workshops/tree/master/LoadingContent). You can also find this tutorial in the Remix Workshops plugin. |
||||
|
||||
For a detailed explanation of the `import` keyword see the |
||||
[Solidity documentation](https://solidity.readthedocs.io/en/develop/layout-of-source-files.html?highlight=import#importing-other-source-files) |
||||
|
||||
Here are a some of the main methods of importing a file: |
||||
|
||||
Importing a file from the browser's local storage |
||||
------------------------------------------------- |
||||
|
||||
Files in Remix can be imported with the `import` key word with the path to the file. Use ```./``` for relative paths to increase portability. |
||||
``` |
||||
pragma solidity >=0.4.22 <0.6.0; |
||||
|
||||
import "./ballot.sol"; |
||||
``` |
||||
|
||||
|
||||
Importing a file from your computer's filesystem |
||||
------------------------------------------------- |
||||
|
||||
This method uses **remixd** - the remix daemon. Please go to the [remixd tutorial](remixd.html) for instructions about how to bridge the divide between the browser and your computers filesystem. |
||||
|
||||
|
||||
Importing from GitHub |
||||
--------------------- |
||||
|
||||
It is possible to import files directly from GitHub. You should specify the release tag (where available), otherwise you will get the latest code in the master branch. For OpenZeppelin Contracts you should only use code published in an official release, the example below imports from OpenZeppelin Contracts v2.5.0. |
||||
|
||||
``` |
||||
pragma solidity >=0.4.22 <0.6.0; |
||||
|
||||
import "https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v2.5.0/contracts/math/SafeMath.sol"; |
||||
|
||||
``` |
||||
|
||||
Importing from Swarm |
||||
-------------------- |
||||
|
||||
Files can be imported using all URLs supported by swarm. |
||||
If you do not have a swarm node, then use swarm-gateways.net. |
||||
|
||||
``` |
||||
import 'bzz-raw://5766400e5d6d822f2029b827331b354c41e0b61f73440851dd0d06f603dd91e5'; |
||||
``` |
||||
|
||||
Importing from IPFS |
||||
-------------------- |
||||
|
||||
Files can be imported from IPFS. |
||||
|
||||
``` |
||||
import 'ipfs://Qmdyq9ZmWcaryd1mgGZ4PttRNctLGUSAMpPqufsk6uRMKh'; |
||||
``` |
||||
|
||||
Importing from the console |
||||
-------------------------- |
||||
|
||||
You can also use a remix command remix.loadurl('<the_url>')in the console. You should specify the release tag (where available), otherwise you will get the latest code in the master branch. For OpenZeppelin Contracts you should only use code published in an official release, the example below imports from OpenZeppelin Contracts v2.5.0. |
||||
|
||||
``` |
||||
remix.loadurl('https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v2.5.0/contracts/math/SafeMath.sol') |
||||
``` |
||||
|
||||
Notice that this will create a `github` folder in the file explorer. To load a file in the `github` folder, you would use a command like this: |
||||
|
||||
``` |
||||
import "github/OpenZeppelin/openzeppelin-contracts/contracts/math/SafeMath.sol"; |
||||
``` |
||||
@ -1,83 +0,0 @@ |
||||
Welcome to Remix documentation! |
||||
=============================== |
||||
|
||||
Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser. |
||||
Written in JavaScript, Remix supports both usage in the browser and locally. |
||||
|
||||
Remix also supports testing, debugging and deploying of smart contracts and much more. |
||||
|
||||
Our Remix project with all its features is available |
||||
at `remix.ethereum.org <http://remix.ethereum.org>`__ and more information can be found in these |
||||
docs. Our IDE tool is available at `our GitHub repository |
||||
<https://github.com/ethereum/remix-ide>`__. |
||||
|
||||
This set of documents covers instructions on how to use Remix and some tutorials to help you get started. |
||||
|
||||
Useful links: |
||||
|
||||
- `Solidity documentation <https://solidity.readthedocs.io>`__ |
||||
|
||||
- `Remix alpha <http://remix-alpha.ethereum.org>`__ - The version where we test new Remix release (not stable!). |
||||
|
||||
- `Remix on Medium <https://medium.com/remix-ide>`__ |
||||
|
||||
- `Ethereum StackExchange for Remix <https://ethereum.stackexchange.com/questions/tagged/remix>`__ |
||||
|
||||
- `Community support channel <https://gitter.im/ethereum/remix>`__ |
||||
|
||||
- `Ðapp Developer resources (Ethereum wiki) <https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources>`__ |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: New Layout Intro |
||||
|
||||
layout |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: Tour of default modules |
||||
|
||||
file_explorer |
||||
plugin_manager |
||||
settings |
||||
solidity_editor |
||||
terminal |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: Tour of typical solidity modules |
||||
|
||||
compile |
||||
run |
||||
udapp |
||||
debugger |
||||
static_analysis |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: Solidity Unit Testing |
||||
|
||||
unittesting |
||||
assert_library |
||||
unittesting_examples |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: Using Remix |
||||
|
||||
contract_metadata |
||||
create_deploy |
||||
tutorial_debug |
||||
import |
||||
remix_commands |
||||
remixd |
||||
FAQ |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
:caption: Miscellaneous |
||||
|
||||
locations |
||||
remix_tutorials_github |
||||
code_contribution_guide |
||||
community |
||||
@ -1,54 +0,0 @@ |
||||
Remix-IDE Layout |
||||
============== |
||||
|
||||
The new structure |
||||
-------------------- |
||||
 |
||||
|
||||
1. Icon Panel - click to change which plugin appears in the Side Panel |
||||
2. Side Panel - Most but not all plugins will have their GUI here. |
||||
3. Main Panel - In the old layout this was just for editing files. In the tabs can be plugins or files for the IDE to compile. |
||||
4. Terminal - where you will see the results of your interactions with the GUI's. Also you can run scripts here. |
||||
|
||||
Icon Panel at Page Load |
||||
----------------------- |
||||
When you load remix - the icon panel show these icons by default. |
||||
|
||||
 |
||||
|
||||
Everything in remix is now a plugin... so the **[Plugin Manager](#plugin-manager)** is very important. |
||||
In the old layout, each basic task in remix was separated into the tabs. Now these tabs are plugins. |
||||
|
||||
But to activate a half a dozen plugins - (or however many you are using) each time the page load is **tedious**. So learn about the **[Environments](#environments)**. |
||||
|
||||
Homepage |
||||
-------- |
||||
|
||||
 |
||||
|
||||
The homepage is located in a tab in the Main Panel. |
||||
|
||||
You can also get there by clicking the remix logo at the top of the icon panel. |
||||
|
||||
### Environments |
||||
Clicking on one of the environment buttons loads up a collection of plugins. We currently have a **Solidity** Button and a **Vyper** button. In the future you will be able to save your own environment. |
||||
|
||||
To see all the plugins go to the **plugin manager** - by selecting the plug in the icon panel. |
||||
 |
||||
|
||||
The environment buttons are time & sanity savers - so you don't need to go to the plugin manager to get started everytime you load the page. |
||||
|
||||
|
||||
Plugin Manager |
||||
--------------- |
||||
|
||||
In order to make Remix flexible for integrating changes into its functionality and for integrating remix into other projects (your's for example), we've now made everything a plugin. This means that you only load the functionality you need. It also means that you need a place to turn off and on plugins - as your needs change. This all happens in the plug manager. |
||||
|
||||
The Plugin Manager is also the place you go when you are creating your own plugin and you want to load your local plugin into Remix. In that case you'd click on the "Connect to a Local Plugin" link at the top of the Plugin Manager panel. |
||||
|
||||
Themes |
||||
--------------- |
||||
|
||||
So you want to work on Remix with a dark theme or a gray theme or just a different theme that the one you are currently looking at? Go to the settings tab and at the bottom is a choice of lots of bootstrap based themes. |
||||
|
||||
 |
||||
@ -1,14 +0,0 @@ |
||||
Finding Remix |
||||
============= |
||||
|
||||
So if you've found the documentation to Remix but don't know where to find Remix or if you want to run the remix-ide locally and want to find out where to download it - this page is here to help. |
||||
|
||||
- An online version is available at [https://remix.ethereum.org](https://remix.ethereum.org). This version is stable and is updated at almost every release. |
||||
- An alpha online version is available at [https://remix-alpha.ethereum.org](https://remix-alpha.ethereum.org). This is not a stable version. |
||||
- npm `remix-ide` package `yarn global add remix-ide`. `remix-ide` create a new instance of `Remix IDE` available at [http://127.0.0.1:8080](http://127.0.0.1:8080) and make the current folder available to Remix IDE by automatically starting `remixd`. |
||||
see [Connection to `remixd`](https://remix-ide.readthedocs.io/en/latest/remixd.html) for more information about sharing local file with `Remix IDE`. |
||||
|
||||
- GitHub release: [https://github.com/ethereum/remix-ide/releases](https://github.com/ethereum/remix-ide/releases) . The source code is packaged at every release but still need to be built using `npm run build`. |
||||
|
||||
- GitHub release: [https://github.com/ethereum/remix-ide/releases](https://github.com/ethereum/remix-ide/releases) . The source code is packaged at every release but still need to be built using `yarn run build`. |
||||
|
||||
@ -1,263 +0,0 @@ |
||||
@ECHO OFF |
||||
|
||||
REM Command file for Sphinx documentation |
||||
|
||||
if "%SPHINXBUILD%" == "" ( |
||||
set SPHINXBUILD=sphinx-build |
||||
) |
||||
set BUILDDIR=_build |
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . |
||||
set I18NSPHINXOPTS=%SPHINXOPTS% . |
||||
if NOT "%PAPER%" == "" ( |
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% |
||||
) |
||||
|
||||
if "%1" == "" goto help |
||||
|
||||
if "%1" == "help" ( |
||||
:help |
||||
echo.Please use `make ^<target^>` where ^<target^> is one of |
||||
echo. html to make standalone HTML files |
||||
echo. dirhtml to make HTML files named index.html in directories |
||||
echo. singlehtml to make a single large HTML file |
||||
echo. pickle to make pickle files |
||||
echo. json to make JSON files |
||||
echo. htmlhelp to make HTML files and a HTML help project |
||||
echo. qthelp to make HTML files and a qthelp project |
||||
echo. devhelp to make HTML files and a Devhelp project |
||||
echo. epub to make an epub |
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
||||
echo. text to make text files |
||||
echo. man to make manual pages |
||||
echo. texinfo to make Texinfo files |
||||
echo. gettext to make PO message catalogs |
||||
echo. changes to make an overview over all changed/added/deprecated items |
||||
echo. xml to make Docutils-native XML files |
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes |
||||
echo. linkcheck to check all external links for integrity |
||||
echo. doctest to run all doctests embedded in the documentation if enabled |
||||
echo. coverage to run coverage check of the documentation if enabled |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "clean" ( |
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i |
||||
del /q /s %BUILDDIR%\* |
||||
goto end |
||||
) |
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any |
||||
%SPHINXBUILD% 1>NUL 2>NUL |
||||
if errorlevel 9009 goto sphinx_python |
||||
goto sphinx_ok |
||||
|
||||
:sphinx_python |
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__ |
||||
%SPHINXBUILD% 2> nul |
||||
if errorlevel 9009 ( |
||||
echo. |
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
||||
echo.installed, then set the SPHINXBUILD environment variable to point |
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you |
||||
echo.may add the Sphinx directory to PATH. |
||||
echo. |
||||
echo.If you don't have Sphinx installed, grab it from |
||||
echo.http://sphinx-doc.org/ |
||||
exit /b 1 |
||||
) |
||||
|
||||
:sphinx_ok |
||||
|
||||
|
||||
if "%1" == "html" ( |
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "dirhtml" ( |
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "singlehtml" ( |
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "pickle" ( |
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished; now you can process the pickle files. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "json" ( |
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished; now you can process the JSON files. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "htmlhelp" ( |
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished; now you can run HTML Help Workshop with the ^ |
||||
.hhp project file in %BUILDDIR%/htmlhelp. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "qthelp" ( |
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
||||
.qhcp project file in %BUILDDIR%/qthelp, like this: |
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Remix.qhcp |
||||
echo.To view the help file: |
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Remix.ghc |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "devhelp" ( |
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "epub" ( |
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "latex" ( |
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "latexpdf" ( |
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
||||
cd %BUILDDIR%/latex |
||||
make all-pdf |
||||
cd %~dp0 |
||||
echo. |
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "latexpdfja" ( |
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
||||
cd %BUILDDIR%/latex |
||||
make all-pdf-ja |
||||
cd %~dp0 |
||||
echo. |
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "text" ( |
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The text files are in %BUILDDIR%/text. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "man" ( |
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "texinfo" ( |
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "gettext" ( |
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "changes" ( |
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.The overview file is in %BUILDDIR%/changes. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "linkcheck" ( |
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Link check complete; look for any errors in the above output ^ |
||||
or in %BUILDDIR%/linkcheck/output.txt. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "doctest" ( |
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Testing of doctests in the sources finished, look at the ^ |
||||
results in %BUILDDIR%/doctest/output.txt. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "coverage" ( |
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Testing of coverage in the sources finished, look at the ^ |
||||
results in %BUILDDIR%/coverage/python.txt. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "xml" ( |
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml. |
||||
goto end |
||||
) |
||||
|
||||
if "%1" == "pseudoxml" ( |
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml |
||||
if errorlevel 1 exit /b 1 |
||||
echo. |
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. |
||||
goto end |
||||
) |
||||
|
||||
:end |
||||
@ -1,22 +0,0 @@ |
||||
Plugin Manager |
||||
=================== |
||||
|
||||
## Everything is a PLUGIN in Remix |
||||
|
||||
In order to integrate new tools made by us and by ...you into Remix, we've now made everything a plugin. |
||||
This architecture will also allow Remix or just parts of Remix to be integrated into other projects (your's for example). |
||||
|
||||
This means that you only load the functionality you need. |
||||
|
||||
It also means that you can turn off and on plugins - as your needs change. |
||||
|
||||
This all happens in the plug manager. |
||||
|
||||
The Plugin Manager is also the place you go when you are creating your own plugin and you want to load your local plugin into Remix. |
||||
|
||||
To load your local plugin, you'd click on the "Connect to a Local Plugin" link at the top of the Plugin Manager panel. |
||||
|
||||
 |
||||
|
||||
To learn more about how to create your own plugin, go to |
||||
[the README of remix-plugin repo](https://github.com/ethereum/remix-plugin). |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue