aniket-engg
4 years ago
commit
4637ad9ed4
@ -0,0 +1,88 @@ |
||||
# Javascript Node CircleCI 2.0 configuration file |
||||
# |
||||
# Check https://circleci.com/docs/2.0/language-javascript/ for more details |
||||
# |
||||
version: 2 |
||||
jobs: |
||||
remix-lib: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-lib && npm test |
||||
|
||||
remix-debug: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-debug && npm test |
||||
|
||||
remix-analyzer: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-analyzer && npm test |
||||
|
||||
remix-tests: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-tests && npm test |
||||
|
||||
remix-astwalker: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-astwalker && npm test |
||||
|
||||
remix-simulator: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-simulator && npm test |
||||
|
||||
remix-url-resolver: |
||||
docker: |
||||
- image: circleci/node:10 |
||||
environment: |
||||
working_directory: ~/repo |
||||
steps: |
||||
- checkout |
||||
- run: npm install && npm run bootstrap |
||||
- run: cd remix-url-resolver && npm run build && npm test |
||||
|
||||
|
||||
workflows: |
||||
version: 2 |
||||
build_all: |
||||
jobs: |
||||
- remix-lib |
||||
- remix-debug |
||||
- remix-analyzer |
||||
- remix-tests |
||||
- remix-astwalker |
||||
- remix-simulator |
||||
- remix-url-resolver |
||||
@ -0,0 +1,17 @@ |
||||
build |
||||
dist |
||||
node_modules |
||||
npm-debug.log |
||||
lint.xml |
||||
.idea |
||||
.vscode |
||||
test-browser/reports/* |
||||
babelify-src |
||||
docs/_build |
||||
.DS_Store |
||||
.tern-port |
||||
TODO |
||||
soljson.js |
||||
lerna-debug.log |
||||
*~ |
||||
/tmp |
||||
@ -0,0 +1,3 @@ |
||||
[submodule "remixd"] |
||||
path = remixd |
||||
url = https://github.com/ethereum/remixd |
||||
@ -0,0 +1 @@ |
||||
.travis.yml |
||||
@ -0,0 +1,679 @@ |
||||
## Change Log |
||||
|
||||
### remix-analyzer 0.5.0-beta.2 (2020/04/01) |
||||
- [#1445](https://github.com/ethereum/remix/pull/1445) analyser module listing updated (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.31 (2020/03/31) |
||||
- [#1444](https://github.com/ethereum/remix/pull/1444) Release 0 1 31 (@Aniket-Engg) |
||||
- [#1438](https://github.com/ethereum/remix/pull/1438) test function with params will throw error (@Aniket-Engg) |
||||
- [#1436](https://github.com/ethereum/remix/pull/1436) accounts count increased to 10 (@Aniket-Engg) |
||||
- [#1434](https://github.com/ethereum/remix/pull/1434) Add type for compilation error (@yann300 ) |
||||
- [#1427](https://github.com/ethereum/remix/pull/1427) Remix-analyzer: LegacyAST to AST (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.30 (2020/02/21 09:53 +00:00) |
||||
- [#1428](https://github.com/ethereum/remix/pull/1428) release 0.1.30 (@Aniket-Engg) |
||||
- [#1425](https://github.com/ethereum/remix/pull/1425) remix-analyzer: js to ts (@Aniket-Engg) |
||||
- [#1423](https://github.com/ethereum/remix/pull/1423) add resetAccounts, new Account, fix getAccounts on remix-simulator (@iurimatias ) |
||||
- [#1422](https://github.com/ethereum/remix/pull/1422) anonymous locals rendering fixed (@Aniket-Engg) |
||||
- [#1419](https://github.com/ethereum/remix/pull/1419) remix-solidity readme updated (@Aniket-Engg) |
||||
- [#1418](https://github.com/ethereum/remix/pull/1418) npmignore file added (@Aniket-Engg) |
||||
- [#1417](https://github.com/ethereum/remix/pull/1417) changelog updated (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.29 (2020/01/29) |
||||
- [#1416](https://github.com/ethereum/remix/pull/1416) bump version (@Aniket-Engg) |
||||
- [#1415](https://github.com/ethereum/remix/pull/1415) undefined value type fixed (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.28 (2020/01/28) |
||||
- [#1414](https://github.com/ethereum/remix/pull/1414) bump versions (@Aniket-Engg) |
||||
- [#1413](https://github.com/ethereum/remix/pull/1413) type mismatch fix for VM transaction instance (@Aniket-Engg) |
||||
- [#1412](https://github.com/ethereum/remix/pull/1412) changelog for v0.1.27 updated (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.27 (2020/01/28 05:54 +00:00) |
||||
- [#1411](https://github.com/ethereum/remix/pull/1411) Release 0.1.27 (@Aniket-Engg) |
||||
- [#1410](https://github.com/ethereum/remix/pull/1410) use compiler configuration in tests (@Aniket-Engg) |
||||
- [#1409](https://github.com/ethereum/remix/pull/1409) Json interface unavailability handled (@Aniket-Engg) |
||||
- [#1407](https://github.com/ethereum/remix/pull/1407) optional final callback in runTestFiles (@Aniket-Engg) |
||||
- [#1406](https://github.com/ethereum/remix/pull/1406) Injected tests.sol (@Aniket-Engg) |
||||
- [#1405](https://github.com/ethereum/remix/pull/1405) added sendRawTransaction (@LianaHus) |
||||
- [#1402](https://github.com/ethereum/remix/pull/1402) pass value in test methods using natspec (@Aniket-Engg) |
||||
- [#1400](https://github.com/ethereum/remix/pull/1400) package.json scripts updated (@Aniket-Engg) |
||||
- [#1399](https://github.com/ethereum/remix/pull/1399) muirGlacier support (@Aniket-Engg) |
||||
- [#1398](https://github.com/ethereum/remix/pull/1398) show storage loading status properly (@Aniket-Engg) |
||||
- [#1396](https://github.com/ethereum/remix/pull/1396) multiple return values display separately (@Aniket-Engg) |
||||
- [#1395](https://github.com/ethereum/remix/pull/1395) remove node.kind check since this is not necessarily present in ast t… (@iurimatias) |
||||
- [#1394](https://github.com/ethereum/remix/pull/1394) Pass executionContext as args to to `try` function (@yann300) |
||||
- [#1393](https://github.com/ethereum/remix/pull/1393) Fix compatibility with web3 1.0.0 (@yann300) |
||||
- [#1391](https://github.com/ethereum/remix/pull/1391) package.json updated (@Aniket-Engg) |
||||
- [#1390](https://github.com/ethereum/remix/pull/1390) initial fixes (@Aniket-Engg) |
||||
- [#1389](https://github.com/ethereum/remix/pull/1389) changelog updated (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.26 (2020/01/10 12:28 +00:00) |
||||
- [#1386](https://github.com/ethereum/remix/pull/1386) Release 0.1.26 (@Aniket-Engg) |
||||
- [#1385](https://github.com/ethereum/remix/pull/1385) compiler import issue fixed (@Aniket-Engg) |
||||
- [#1384](https://github.com/ethereum/remix/pull/1384) catch and return deployment error in remix-tests (@Aniket-Engg) |
||||
- [#1382](https://github.com/ethereum/remix/pull/1382) receive function support added (@Aniket-Engg) |
||||
- [#1380](https://github.com/ethereum/remix/pull/1380) constructor ABI fixed (@Aniket-Engg) |
||||
- [#1377](https://github.com/ethereum/remix/pull/1377) remix-solidity: js to ts (@Aniket-Engg) |
||||
- [#1374](https://github.com/ethereum/remix/pull/1374) changelog updated (@Aniket-Engg) |
||||
- [#1372](https://github.com/ethereum/remix/pull/1372) Syntax updates2 (@iurimatias) |
||||
- [#1363](https://github.com/ethereum/remix/pull/1363) update syntax to use const, let and this (@iurimatias) |
||||
- [#1362](https://github.com/ethereum/remix/pull/1362) refactor execution context (@iurimatias) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.25 (2019/12/23) |
||||
- [#1373](https://github.com/ethereum/remix/pull/1373) Release 0.1.25 (@Aniket-Engg ) |
||||
- [#1371](https://github.com/ethereum/remix/pull/1371) use web3 utils (@Aniket-Engg ) |
||||
- [#1369](https://github.com/ethereum/remix/pull/1369) network id fixed (@Aniket-Engg ) |
||||
- [#1368](https://github.com/ethereum/remix/pull/1368) solc 0.6.0 compatibility (@Aniket-Engg ) |
||||
- [#1359](https://github.com/ethereum/remix/pull/1359) web3 and ethers version update (@Aniket-Engg ) |
||||
- [#1358](https://github.com/ethereum/remix/pull/1358) task updated & comments added (@Aniket-Engg ) |
||||
- [#1357](https://github.com/ethereum/remix/pull/1357) changelog updated (@Aniket-Engg ) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.24 (2019/12/10) |
||||
- [#1356](https://github.com/ethereum/remix/pull/1356) Publish 0.1.24 (@Aniket-Engg ) |
||||
- [#1355](https://github.com/ethereum/remix/pull/1355) bool type encoding handled (@Aniket-Engg ) |
||||
- [#1354](https://github.com/ethereum/remix/pull/1354) changelog added (@Aniket-Engg) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.23 (2019/12/06 18:29 +00:00) |
||||
- [#1353](https://github.com/ethereum/remix/pull/1353) Release 0.1.23 (@Aniket-Engg ) |
||||
- [#1352](https://github.com/ethereum/remix/pull/1352) solc version updated for remix-lib tests (@Aniket-Engg ) |
||||
- [#1351](https://github.com/ethereum/remix/pull/1351) use new solc version. Update the interface (@LianaHus) |
||||
- [#1349](https://github.com/ethereum/remix/pull/1349) event triggered to get full storage (@Aniket-Engg ) |
||||
- [#1347](https://github.com/ethereum/remix/pull/1347) Fixed a bug with the wrong event name (@EthanWan ) |
||||
- [#1346](https://github.com/ethereum/remix/pull/1346) changelog & gulpfile updated (@Aniket-Engg ) |
||||
- [#1341](https://github.com/ethereum/remix/pull/1341) ethereumjs-vm version update with istanbul support (@Aniket-Engg ) |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.22 (2019/12/03 06:03 +00:00) |
||||
- [#1345](https://github.com/ethereum/remix/pull/1345) Bump version 0.1.22 (@Aniket-Engg ) |
||||
- [#1344](https://github.com/ethereum/remix/pull/1344) null worker before next load (@LianaHus ) |
||||
- [#1343](https://github.com/ethereum/remix/pull/1343) libs description updated (@Aniket-Engg ) |
||||
- [#1339](https://github.com/ethereum/remix/pull/1339) remix-solidity dependencies & readme updated (@Aniket-Engg ) |
||||
- [#1338](https://github.com/ethereum/remix/pull/1338) test file suffix checks improved (@Aniket-Engg ) |
||||
- [#1337](https://github.com/ethereum/remix/pull/1337) twice error catching improved (@Aniket-Engg ) |
||||
- [#1336](https://github.com/ethereum/remix/pull/1336) contribution file updated (@Aniket-Engg ) |
||||
- [#1335](https://github.com/ethereum/remix/pull/1335) package.json updated (@Aniket-Engg ) |
||||
- [#1334](https://github.com/ethereum/remix/pull/1334) more types added in remix-tests (@Aniket-Engg ) |
||||
- [#1333](https://github.com/ethereum/remix/pull/1333) added an exception catch (@LianaHus ) |
||||
- [#1332](https://github.com/ethereum/remix/pull/1332) remix-tests readme update (@Aniket-Engg ) |
||||
- [#1323](https://github.com/ethereum/remix/pull/1323) Bump lodash.mergewith from 4.6.1 to 4.6.2 in /remix-debugger (@dependabot[bot]) |
||||
- [#1324](https://github.com/ethereum/remix/pull/1324) Bump lodash from 4.17.11 to 4.17.15 in /remix-debugger (@dependabot[bot]) |
||||
- [#1329](https://github.com/ethereum/remix/pull/1329) sequence for tests (@Aniket-Engg) |
||||
- [#1327](https://github.com/ethereum/remix/pull/1327) import supported in test contract (@Aniket-Engg) |
||||
- [#1325](https://github.com/ethereum/remix/pull/1325) initiate provider (@Aniket-Engg) |
||||
- [#1272](https://github.com/ethereum/remix/pull/1272) Implement filters; add more tests; eth_getStorageAt (@Aniket-Engg, @iurimatias) |
||||
- [#1317](https://github.com/ethereum/remix/pull/1317) tests for #1314 (@Aniket-Engg) |
||||
- [#1314](https://github.com/ethereum/remix/pull/1314) loop over dynamic array length will show warning (@Aniket-Engg) |
||||
- [#1315](https://github.com/ethereum/remix/pull/1315) ethereumjs-util version updated to latest in all modules (@Aniket-Engg) |
||||
- [#1311](https://github.com/ethereum/remix/pull/1311) transaction execution error recorded (@Aniket-Engg) |
||||
- [#1313](https://github.com/ethereum/remix/pull/1313) delete from mapping will not show warning (@Aniket-Engg) |
||||
- [#1312](https://github.com/ethereum/remix/pull/1312) update remix-tests unit tests (@0mkara) |
||||
- [#1310](https://github.com/ethereum/remix/pull/1310) bytecode updated after library linking (@Aniket-Engg) |
||||
- [#1307](https://github.com/ethereum/remix/pull/1307) changelog auto update (@Aniket-Engg) |
||||
- [#1308](https://github.com/ethereum/remix/pull/1308) Separate AST blocks in remix-analyzer tests (@Aniket-Engg) |
||||
- [#1306](https://github.com/ethereum/remix/pull/1306) changelog updated (@Aniket-Engg) |
||||
|
||||
<a name="v0.1.21"></a> |
||||
# [v0.1.21](https://github.com/ethereum/remix/releases/tag/v0.1.21) - 30 Sep 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.21 (2019/09/30 07:37 +00:00) |
||||
- [#1305](https://github.com/ethereum/remix/pull/1305) Release v0.1.21 (@Aniket-Engg) |
||||
- [#1303](https://github.com/ethereum/remix/pull/1303) remix tests worked with compiler loaded using web-worker (@Aniket-Engg) |
||||
- [#1242](https://github.com/ethereum/remix/pull/1242) [Static analysis] Interaction with different addresses inside the loop handled (@Aniket-Engg) |
||||
- [#1301](https://github.com/ethereum/remix/pull/1301) Makes plugin sendTransaction work with non-vm providers, add tests (@bmcd87) |
||||
- [#1300](https://github.com/ethereum/remix/pull/1300) function params parsing improved (@Aniket-Engg) |
||||
- [#1299](https://github.com/ethereum/remix/pull/1299) opcodes added (@Aniket-Engg) |
||||
- [#1298](https://github.com/ethereum/remix/pull/1298) changelog updated (@Aniket-Engg) |
||||
|
||||
[Changes][v0.1.21] |
||||
|
||||
|
||||
<a name="v0.1.20"></a> |
||||
# [v0.1.20](https://github.com/ethereum/remix/releases/tag/v0.1.20) - 20 Sep 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.20 (2019/09/20 13:38 +00:00) |
||||
- [#1297](https://github.com/ethereum/remix/pull/1297) Release 0.1.20 (@Aniket-Engg) |
||||
- [#1296](https://github.com/ethereum/remix/pull/1296) changelog added (@Aniket-Engg) |
||||
- [#1294](https://github.com/ethereum/remix/pull/1294) string with comma handled (@Aniket-Engg) |
||||
- [#1292](https://github.com/ethereum/remix/pull/1292) internal function call handling (@Aniket-Engg) |
||||
- [#1204](https://github.com/ethereum/remix/pull/1204) Bump solidity version used for testing remix-lib (@Aniket-Engg, @yann300) |
||||
- [#1291](https://github.com/ethereum/remix/pull/1291) updated package-lock.json (@Aniket-Engg) |
||||
- [#1244](https://github.com/ethereum/remix/pull/1244) Added package-lock.json files to all the subprojects (@edisinovcic) |
||||
- [#1290](https://github.com/ethereum/remix/pull/1290) Added comments in Internal call tree (@Aniket-Engg, @yann300) |
||||
- [#1285](https://github.com/ethereum/remix/pull/1285) https for debug node (@yann300) |
||||
- [#1267](https://github.com/ethereum/remix/pull/1267) working websocket support; implement eth_subscribe; eth_unsubscribe; eth_getLogs (@iurimatias) |
||||
- [#1277](https://github.com/ethereum/remix/pull/1277) Update test runner to report accounts via callback (@andremedeiros) |
||||
|
||||
[Changes][v0.1.20] |
||||
|
||||
|
||||
<a name="v0.1.19"></a> |
||||
# [v0.1.19](https://github.com/ethereum/remix/releases/tag/v0.1.19) - 04 Sep 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.19 (2019/09/04 14:08 +00:00) |
||||
- [#1284](https://github.com/ethereum/remix/pull/1284) Bump version (@yann300) |
||||
- [#1283](https://github.com/ethereum/remix/pull/1283) Fix swarm hash extraction (@yann300) |
||||
|
||||
[Changes][v0.1.19] |
||||
|
||||
|
||||
<a name="v0.1.18"></a> |
||||
# [v0.1.18](https://github.com/ethereum/remix/releases/tag/v0.1.18) - 04 Sep 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.18 (2019/09/04 10:47 +00:00) |
||||
- [#1282](https://github.com/ethereum/remix/pull/1282) Bump version (@yann300) |
||||
- [#1281](https://github.com/ethereum/remix/pull/1281) Init remix-simulator (@yann300) |
||||
|
||||
[Changes][v0.1.18] |
||||
|
||||
|
||||
<a name="v0.1.17"></a> |
||||
# [v0.1.17](https://github.com/ethereum/remix/releases/tag/v0.1.17) - 03 Sep 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.17 (2019/09/03 14:55 +00:00) |
||||
- [#1279](https://github.com/ethereum/remix/pull/1279) Bump version (@yann300) |
||||
- [#1278](https://github.com/ethereum/remix/pull/1278) Fix sending non state changing call (@yann300) |
||||
|
||||
[Changes][v0.1.17] |
||||
|
||||
|
||||
<a name="v0.1.16"></a> |
||||
# [v0.1.16](https://github.com/ethereum/remix/releases/tag/v0.1.16) - 29 Aug 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.16 (2019/08/29 08:49 +00:00) |
||||
- [#1275](https://github.com/ethereum/remix/pull/1275) Increment root package (@yann300) |
||||
- [#1274](https://github.com/ethereum/remix/pull/1274) Bump version (@yann300) |
||||
- [#1273](https://github.com/ethereum/remix/pull/1273) checking of the type of id (@LianaHus) |
||||
- [#1269](https://github.com/ethereum/remix/pull/1269) '_deps' is not longer defined (@yann300) |
||||
- [#1270](https://github.com/ethereum/remix/pull/1270) Update extracting swarm hash (@yann300) |
||||
- [#1268](https://github.com/ethereum/remix/pull/1268) Use name 'web3' when custom provider (@yann300) |
||||
- [#1256](https://github.com/ethereum/remix/pull/1256) Return compilation result instead of a label && take in account the error prop… (@yann300) |
||||
- [#1265](https://github.com/ethereum/remix/pull/1265) Remove network check in `silentRunTx` (@yann300) |
||||
- [#1259](https://github.com/ethereum/remix/pull/1259) added copy of payable and stateMutability to the constructor ABI (@LianaHus) |
||||
- [#1211](https://github.com/ethereum/remix/pull/1211) implement more methods in remix-sim (@iurimatias) |
||||
|
||||
[Changes][v0.1.16] |
||||
|
||||
|
||||
<a name="v0.1.15"></a> |
||||
# [v0.1.15](https://github.com/ethereum/remix/releases/tag/v0.1.15) - 15 Jul 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.15 (2019/07/15 12:39 +00:00) |
||||
- [#1252](https://github.com/ethereum/remix/pull/1252) Bump version (@yann300) |
||||
- [#1251](https://github.com/ethereum/remix/pull/1251) Udapp as class (@GrandSchtroumpf) |
||||
- [#1249](https://github.com/ethereum/remix/pull/1249) update with latest links to readthedocs (@LianaHus) |
||||
|
||||
[Changes][v0.1.15] |
||||
|
||||
|
||||
<a name="v0.1.14"></a> |
||||
# [v0.1.14](https://github.com/ethereum/remix/releases/tag/v0.1.14) - 03 Jul 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.14 (2019/07/03 13:42 +00:00) |
||||
- [#1246](https://github.com/ethereum/remix/pull/1246) Bump version (@yann300) |
||||
- [#1245](https://github.com/ethereum/remix/pull/1245) removed 'detail' key of optimizer for versions before yul (@LianaHus) |
||||
- [#1223](https://github.com/ethereum/remix/pull/1223) Add more position conversion functions (@rocky) |
||||
- [#1238](https://github.com/ethereum/remix/pull/1238) Fix #950 (@0mkara, @yann300) |
||||
|
||||
|
||||
[Changes][v0.1.14] |
||||
|
||||
|
||||
<a name="v0.1.13"></a> |
||||
# [v0.1.13](https://github.com/ethereum/remix/releases/tag/v0.1.13) - 25 Jun 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.13 (2019/06/25 08:02 +00:00) |
||||
- [#1236](https://github.com/ethereum/remix/pull/1236) output ast from compilation result (@yann300) |
||||
- [#1234](https://github.com/ethereum/remix/pull/1234) use babel 7 (@yann300) |
||||
|
||||
[Changes][v0.1.13] |
||||
|
||||
|
||||
<a name="v0.1.12"></a> |
||||
# [v0.1.12](https://github.com/ethereum/remix/releases/tag/v0.1.12) - 24 Jun 2019 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.12 (2019/06/24 07:50 +00:00) |
||||
- [#1232](https://github.com/ethereum/remix/pull/1232) bump version (@yann300) |
||||
- [#1228](https://github.com/ethereum/remix/pull/1228) Enable yul optimizations if optimizations are enabled and in Yul mode. (@yann300, @chriseth) |
||||
- [#1221](https://github.com/ethereum/remix/pull/1221) add scripts for removing installation (@yann300) |
||||
- [#1231](https://github.com/ethereum/remix/pull/1231) Create job_opening.md (@yann300) |
||||
- [#1222](https://github.com/ethereum/remix/pull/1222) Use babel 7 (@yann300) |
||||
- [#1216](https://github.com/ethereum/remix/pull/1216) Add routines for finding AST nodes (@rocky) |
||||
- [#1215](https://github.com/ethereum/remix/pull/1215) WIP: Import fix for vscode integration (@0mkara) |
||||
- [#1220](https://github.com/ethereum/remix/pull/1220) remove everything but link to new location of docs (@ethereum) |
||||
- [#1219](https://github.com/ethereum/remix/pull/1219) Default abi if compiled with yul (@yann300) |
||||
- [#1218](https://github.com/ethereum/remix/pull/1218) Version bump (@yann300) |
||||
- [#1217](https://github.com/ethereum/remix/pull/1217) Set language for solidity compiler (@yann300) |
||||
- [#1210](https://github.com/ethereum/remix/pull/1210) fixing #2029 static Analysis Location Issue (@LianaHus) |
||||
- [#1193](https://github.com/ethereum/remix/pull/1193) remix-solidity: add compiler.setEvmVersion() (@scottt) |
||||
- [#1213](https://github.com/ethereum/remix/pull/1213) Small spelling typos (@rocky) |
||||
- [#1195](https://github.com/ethereum/remix/pull/1195) remove `console.error` (@yann300) |
||||
- [#1196](https://github.com/ethereum/remix/pull/1196) Docs update (@ethereum) |
||||
- [#1187](https://github.com/ethereum/remix/pull/1187) Docs new layout (@ryestew) |
||||
- [#1192](https://github.com/ethereum/remix/pull/1192) publish lerna (@yann300) |
||||
- [#1190](https://github.com/ethereum/remix/pull/1190) Various Fix on Debugger (@yann300) |
||||
- [#1160](https://github.com/ethereum/remix/pull/1160) add more methods to remix-sim; fix accounts (@iurimatias) |
||||
- [#1183](https://github.com/ethereum/remix/pull/1183) Update README.md (@yann300) |
||||
|
||||
[Changes][v0.1.12] |
||||
|
||||
|
||||
<a name="v0.1.10"></a> |
||||
# [v0.1.10](https://github.com/ethereum/remix/releases/tag/v0.1.10) - 11 May 2019 |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.4.6 |
||||
remix-analyzer@0.3.6 |
||||
remix-debug@0.3.6 |
||||
remix-simulator@0.1.6 |
||||
remix-tests@0.1.7 |
||||
remix-solidity@0.3.6 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.10 (2019/05/11 07:44 +00:00) |
||||
- [#1182](https://github.com/ethereum/remix/pull/1182) Bump version (@yann300) |
||||
- [#1181](https://github.com/ethereum/remix/pull/1181) move to ethers v4 (@yann300) |
||||
- [#1158](https://github.com/ethereum/remix/pull/1158) Remove duplicated function declaration 'Ethdebugger.prototype.debug' (@nujabes403) |
||||
- [#1180](https://github.com/ethereum/remix/pull/1180) remix-debug depends on web3 (@scottt) |
||||
- [#1177](https://github.com/ethereum/remix/pull/1177) Update universalDapp.js (fix bad reference) (@yann300) |
||||
- [#1176](https://github.com/ethereum/remix/pull/1176) add görli test net declaration (contract metadata) (@yann300) |
||||
- [#1172](https://github.com/ethereum/remix/pull/1172) fix for electron w/dynamic loading of solcjson (@subtly) |
||||
|
||||
|
||||
[Changes][v0.1.10] |
||||
|
||||
|
||||
<a name="v0.1.9"></a> |
||||
# [v0.1.9](https://github.com/ethereum/remix/releases/tag/v0.1.9) - 23 Apr 2019 |
||||
|
||||
|
||||
- Update regex for fixing Firefox support [#1165](https://github.com/ethereum/remix/pull/1165) |
||||
- Improving error message [#1164](https://github.com/ethereum/remix/pull/1164) |
||||
- Update universal-dapp.js for Constantinople support [#1161](https://github.com/ethereum/remix/pull/1161) |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.4.5 |
||||
remix-analyzer@0.3.5 |
||||
remix-debug@0.3.5 |
||||
remix-simulator@0.1.5 |
||||
remix-tests@0.1.6 |
||||
remix-solidity@0.3.5 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.9 (2019/04/23 15:41 +00:00) |
||||
- [#1170](https://github.com/ethereum/remix/pull/1170) Bump version (@yann300) |
||||
- [#1165](https://github.com/ethereum/remix/pull/1165) fix: update regex to be Firefox compatible (@andremedeiros) |
||||
- [#1164](https://github.com/ethereum/remix/pull/1164) Better error msg (@LianaHus) |
||||
- [#1159](https://github.com/ethereum/remix/pull/1159) Fix typo 'invokation' to 'invocation' (@nujabes403) |
||||
- [#1161](https://github.com/ethereum/remix/pull/1161) Update universalDapp.js - support ethereumjs-vm 2.5.0 (@yann300) |
||||
|
||||
[Changes][v0.1.9] |
||||
|
||||
|
||||
<a name="v0.1.8"></a> |
||||
# [v0.1.8](https://github.com/ethereum/remix/releases/tag/v0.1.8) - 17 Apr 2019 |
||||
|
||||
|
||||
- release of remix-astwalker |
||||
- move `universal-dapp` logic from remix IDE to remix repository |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.4.4 |
||||
remix-analyzer@0.3.4 |
||||
remix-debug@0.3.4 |
||||
remix-simulator@0.1.4 |
||||
remix-tests@0.1.5 |
||||
remix-solidity@0.3.4 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.8 (2019/04/17 11:49 +00:00) |
||||
- [#1156](https://github.com/ethereum/remix/pull/1156) remix-astwalker (@0mkara) |
||||
- [#1150](https://github.com/ethereum/remix/pull/1150) move universal-dapp logic from remix-ide to remix-lib (@iurimatias) |
||||
|
||||
|
||||
[Changes][v0.1.8] |
||||
|
||||
|
||||
<a name="v0.1.7"></a> |
||||
# [v0.1.7](https://github.com/ethereum/remix/releases/tag/v0.1.7) - 03 Apr 2019 |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.4.3 |
||||
remix-analyzer@0.3.3 |
||||
remix-debug@0.3.3 |
||||
remix-simulator@0.1.3 |
||||
remix-tests@0.1.4 |
||||
remix-url-resolver@0.0.5 |
||||
remix-solidity@0.3.3 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.7 (2019/04/03 10:27 +00:00) |
||||
- [#1153](https://github.com/ethereum/remix/pull/1153) Bump ethereumjs-vm version (3.0.0) (@yann300) |
||||
- [#1151](https://github.com/ethereum/remix/pull/1151) Various fixes in remix-tests (@0mkara, @yann300) |
||||
|
||||
[Changes][v0.1.7] |
||||
|
||||
|
||||
<a name="v0.1.6"></a> |
||||
# [v0.1.6](https://github.com/ethereum/remix/releases/tag/v0.1.6) - 28 Mar 2019 |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.4.2 |
||||
remix-analyzer@0.3.2 |
||||
remix-debug@0.3.2 |
||||
remix-simulator@0.1.2 |
||||
remix-tests@0.1.3 |
||||
remix-url-resolver@0.0.4 |
||||
|
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.6 (2019/03/28 13:35 +00:00) |
||||
- [#1128](https://github.com/ethereum/remix/pull/1128) Remix Tests Typescript implementation (@0mkara, @Sab94) |
||||
- [#1133](https://github.com/ethereum/remix/pull/1133) Fix typo (@PatAltimore) |
||||
- [#1138](https://github.com/ethereum/remix/pull/1138) manage metamask privacy mode (@yann300) |
||||
- [#1141](https://github.com/ethereum/remix/pull/1141) constantinople support (JSVM) (@yann300) |
||||
- [#1136](https://github.com/ethereum/remix/pull/1136) run remix-lib tests on v0.5.4+commit.9549d8ff (@iurimatias, @yann300) |
||||
- [#1137](https://github.com/ethereum/remix/pull/1137) fix: handle bignumber conversion on hash without prefix (@andremedeiros) |
||||
- [#1131](https://github.com/ethereum/remix/pull/1131) ethereum/populus is no longer maintained. Use ours. (@0mkara) |
||||
- [#1124](https://github.com/ethereum/remix/pull/1124) Updated regex in Memory Debugger to exclude replacing space with '?' (@eswarasai) |
||||
- [#1127](https://github.com/ethereum/remix/pull/1127) Fix test (@yann300) |
||||
- [#1122](https://github.com/ethereum/remix/pull/1122) fix: storageRangeAt doesn't always take a callback (@andremedeiros) |
||||
- [#1120](https://github.com/ethereum/remix/pull/1120) Allow timestamps to be passed to rawRun (@LeviBarnes) |
||||
- [#1117](https://github.com/ethereum/remix/pull/1117) Add module declaration (@0mkara) |
||||
- [#1115](https://github.com/ethereum/remix/pull/1115) Update README.md (@yann300) |
||||
- [#1112](https://github.com/ethereum/remix/pull/1112) improve userdoc for sender account (@0mkara) |
||||
- [#1114](https://github.com/ethereum/remix/pull/1114) Fix tests (@yann300) |
||||
- [#1113](https://github.com/ethereum/remix/pull/1113) Update package.json (@yann300) |
||||
- [#1110](https://github.com/ethereum/remix/pull/1110) Fix remix-url-resolver package.json (@0mkara) |
||||
- [#1109](https://github.com/ethereum/remix/pull/1109) add bins & command line params for simulator and debugger (@iurimatias) |
||||
- [#1107](https://github.com/ethereum/remix/pull/1107) Update release-process.md (@yann300) |
||||
- [#1106](https://github.com/ethereum/remix/pull/1106) fix remix-url-resolver package.json (@0mkara) |
||||
- [#1100](https://github.com/ethereum/remix/pull/1100) Remix resolve (@0mkara) |
||||
- [#1105](https://github.com/ethereum/remix/pull/1105) Fix remix-lib test (@yann300) |
||||
- [#1104](https://github.com/ethereum/remix/pull/1104) update package versions to be in line with npm (@iurimatias) |
||||
- [#1047](https://github.com/ethereum/remix/pull/1047) unit testing fix for PR #1014 (@yann300, @0mkara, @fulldecent) |
||||
- [#1094](https://github.com/ethereum/remix/pull/1094) (initial) lib for rdb (@iurimatias) |
||||
- [#1095](https://github.com/ethereum/remix/pull/1095) fix txFormat tests (@iurimatias) |
||||
- [#1089](https://github.com/ethereum/remix/pull/1089) Update tests.sol.js (@LianaHus) |
||||
- [#1090](https://github.com/ethereum/remix/pull/1090) rename filename to fix uppercase issue causing issues in remix-debug (@iurimatias) |
||||
- [#1084](https://github.com/ethereum/remix/pull/1084) move non prod dependencies to devDependencies (@iurimatias) |
||||
- [#1083](https://github.com/ethereum/remix/pull/1083) add websocket support for remix-sim (@iurimatias) |
||||
- [#1082](https://github.com/ethereum/remix/pull/1082) add missing send method (@iurimatias) |
||||
- [#995](https://github.com/ethereum/remix/pull/995) move debugger logic from remix-ide to remix-debug (@iurimatias) |
||||
- [#1080](https://github.com/ethereum/remix/pull/1080) Update config.yml (@yann300) |
||||
- [#1050](https://github.com/ethereum/remix/pull/1050) Check RETURN and REVERT instruction .... (@yann300) |
||||
- [#1077](https://github.com/ethereum/remix/pull/1077) Fix and rename makeFullTypeDefinition (@yann300) |
||||
- [#1079](https://github.com/ethereum/remix/pull/1079) changed RemixD's to `remixd` (@LianaHus) |
||||
- [#1078](https://github.com/ethereum/remix/pull/1078) added info about read-only mode for remixd (@LianaHus) |
||||
|
||||
[Changes][v0.1.6] |
||||
|
||||
|
||||
<a name="v0.1.5"></a> |
||||
# [v0.1.5](https://github.com/ethereum/remix/releases/tag/v0.1.5) - 22 Nov 2018 |
||||
|
||||
## Packages |
||||
|
||||
remix-analyzer@0.2.13 |
||||
remix-debug@0.2.14 |
||||
remix-lib@0.3.13 |
||||
remix-simulator@0.0.8 |
||||
remix-solidity@0.2.14 |
||||
remix-tests@0.0.21 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.5 (2018/11/22 13:45 +00:00) |
||||
- [#1076](https://github.com/ethereum/remix/pull/1076) Bump version (@yann300) |
||||
- [#1075](https://github.com/ethereum/remix/pull/1075) Revert "Update package.json" (@yann300) |
||||
- [#1074](https://github.com/ethereum/remix/pull/1074) Update package.json (@yann300) |
||||
- [#1073](https://github.com/ethereum/remix/pull/1073) Update package.json (@yann300) |
||||
- [#1072](https://github.com/ethereum/remix/pull/1072) Update unittesting_tab.md (fix doc rendering) (@yann300) |
||||
|
||||
[Changes][v0.1.5] |
||||
|
||||
|
||||
<a name="v0.1.4"></a> |
||||
# [v0.1.4](https://github.com/ethereum/remix/releases/tag/v0.1.4) - 21 Nov 2018 |
||||
|
||||
## Packages |
||||
|
||||
remix-tests@0.0.20 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.4 (2018/11/21 10:15 +00:00) |
||||
- [#1071](https://github.com/ethereum/remix/pull/1071) bump general version (@yann300) |
||||
- [#1070](https://github.com/ethereum/remix/pull/1070) bump version (@yann300) |
||||
- [#1067](https://github.com/ethereum/remix/pull/1067) include test libraries import statements into sources anyway (@LianaHus) |
||||
- [#1065](https://github.com/ethereum/remix/pull/1065) Add argument to connect local folder to remix-ide and Provide an example (@hskang9) |
||||
- [#1069](https://github.com/ethereum/remix/pull/1069) Make unit testing work for solidity < 0.5.0 (@yann300) |
||||
|
||||
[Changes][v0.1.4] |
||||
|
||||
|
||||
<a name="v0.1.3"></a> |
||||
# [v0.1.3](https://github.com/ethereum/remix/releases/tag/v0.1.3) - 19 Nov 2018 |
||||
|
||||
This release provides Solidity 0.5.0 support. |
||||
|
||||
## Packages |
||||
|
||||
remix-lib@0.3.12 |
||||
remix-debug@0.2.13 |
||||
remix-simulator@0.0.7 |
||||
remix-solidity@0.2.13 |
||||
remix-analyzer@0.2.12 |
||||
remix-tests@0.0.19 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.3 (2018/11/19 20:28 +00:00) |
||||
- [#1066](https://github.com/ethereum/remix/pull/1066) Bump version solidity 0.5 support (@yann300) |
||||
- [#1060](https://github.com/ethereum/remix/pull/1060) Fix static analysis 0.5 (@yann300, @LianaHus) |
||||
- [#1053](https://github.com/ethereum/remix/pull/1053) fixes tests for solc-js 0.5.0 (@yann300, @LianaHus) |
||||
- [#1056](https://github.com/ethereum/remix/pull/1056) Create release-process.md (@yann300) |
||||
|
||||
[Changes][v0.1.3] |
||||
|
||||
|
||||
<a name="v0.1.2"></a> |
||||
# [v0.1.2](https://github.com/ethereum/remix/releases/tag/v0.1.2) - 15 Nov 2018 |
||||
|
||||
## Published packages |
||||
|
||||
remix-lib@0.3.11 |
||||
remix-debug@0.2.12 |
||||
remix-simulator@0.0.6 |
||||
remix-solidity@0.2.12 |
||||
remix-analyzer@0.2.11 |
||||
remix-tests@0.0.18 |
||||
|
||||
## Change Log |
||||
|
||||
### v0.1.2 (2018/11/15 09:57 +00:00) |
||||
- [#1055](https://github.com/ethereum/remix/pull/1055) bump version (@yann300) |
||||
- [#1054](https://github.com/ethereum/remix/pull/1054) publish (@yann300) |
||||
- [#1049](https://github.com/ethereum/remix/pull/1049) Fix unit testing error message (@yann300) |
||||
- [#1042](https://github.com/ethereum/remix/pull/1042) add Remixd (@yann300) |
||||
- [#1012](https://github.com/ethereum/remix/pull/1012) Compile if solidity is fixed version, fixes #1011 (@fulldecent) |
||||
- [#1018](https://github.com/ethereum/remix/pull/1018) Link to example project using remix-test with CI (@fulldecent) |
||||
- [#1017](https://github.com/ethereum/remix/pull/1017) Link to example project that uses Travis + Remix-tests (@fulldecent) |
||||
- [#1038](https://github.com/ethereum/remix/pull/1038) Delete .travis.yml (@yann300) |
||||
- [#1037](https://github.com/ethereum/remix/pull/1037) Update README.md (@yann300) |
||||
- [#1036](https://github.com/ethereum/remix/pull/1036) Update README.md (@yann300) |
||||
- [#1004](https://github.com/ethereum/remix/pull/1004) Set the msg.sender in the solidity userdoc (@yann300) |
||||
- [#1010](https://github.com/ethereum/remix/pull/1010) publishing (@yann300) |
||||
|
||||
[Changes][v0.1.2] |
||||
|
||||
|
||||
<a name="v0.1.1"></a> |
||||
# [v0.1.1](https://github.com/ethereum/remix/releases/tag/v0.1.1) - 24 Oct 2018 |
||||
|
||||
Change log |
||||
|
||||
https://github.com/ethereum/remix/compare/v0.1.0...v0.1.1 |
||||
|
||||
[Changes][v0.1.1] |
||||
|
||||
|
||||
<a name="v0.1.0"></a> |
||||
# [v0.1.0](https://github.com/ethereum/remix/releases/tag/v0.1.0) - 24 Oct 2018 |
||||
|
||||
Changelog: |
||||
|
||||
https://github.com/ethereum/remix/compare/remix-tests@0.0.13...v0.1.0 |
||||
|
||||
[Changes][v0.1.0] |
||||
|
||||
|
||||
<a name="remix-lib@0.2.9"></a> |
||||
# [remix-lib@0.2.9](https://github.com/ethereum/remix/releases/tag/remix-lib@0.2.9) - 13 Jun 2018 |
||||
|
||||
# Changelog |
||||
|
||||
- Use tx and receipt when resolving / listening [#848](https://github.com/ethereum/remix/pull/848) |
||||
|
||||
[Changes][remix-lib@0.2.9] |
||||
|
||||
|
||||
<a name="remix-lib@0.2.8"></a> |
||||
# [remix-lib@0.2.8](https://github.com/ethereum/remix/releases/tag/remix-lib@0.2.8) - 11 Jun 2018 |
||||
|
||||
## remix-lib@0.2.8 (11/06/2018) |
||||
- Retrieve receipt [#844](https://github.com/ethereum/remix/pull/844) |
||||
|
||||
|
||||
[Changes][remix-lib@0.2.8] |
||||
|
||||
|
||||
<a name="remix-solidity@0.1.8"></a> |
||||
# [remix-solidity@0.1.8](https://github.com/ethereum/remix/releases/tag/remix-solidity@0.1.8) - 29 May 2018 |
||||
|
||||
# Changelog |
||||
|
||||
## remix-solidity@0.1.8 (29/05/2018) |
||||
|
||||
- Static analysis: Unassigned binary operations [#786](https://github.com/ethereum/remix/pull/786) |
||||
- Static Analysis: Bugfix constant function check, Similar var names al… [#766](https://github.com/ethereum/remix/pull/766) |
||||
|
||||
[Changes][remix-solidity@0.1.8] |
||||
|
||||
|
||||
<a name="remix-lib@0.2.6"></a> |
||||
# [remix-lib@0.2.6](https://github.com/ethereum/remix/releases/tag/remix-lib@0.2.6) - 29 May 2018 |
||||
|
||||
# Changelog |
||||
|
||||
## remix-lib@0.2.6 (29/05/2018) |
||||
|
||||
- decode / encode tuple [#795](https://github.com/ethereum/remix/pull/795) |
||||
- Fix encoding fallback function [#791](https://github.com/ethereum/remix/pull/791) |
||||
- Fix library bytecode comparison [#790](https://github.com/ethereum/remix/pull/790) |
||||
|
||||
[Changes][remix-lib@0.2.6] |
||||
|
||||
|
||||
<a name="remix-debug@0.0.6"></a> |
||||
# [remix-debug@0.0.6](https://github.com/ethereum/remix/releases/tag/remix-debug@0.0.6) - 29 May 2018 |
||||
|
||||
# Changelog |
||||
|
||||
## remix-debug@0.0.6 (29/05/2018) |
||||
|
||||
- move most dev dependencies to dependencies [#803](https://github.com/ethereum/remix/pull/803) |
||||
|
||||
[Changes][remix-debug@0.0.6] |
||||
|
||||
|
||||
<a name="remix-lib@0.2.5"></a> |
||||
# [remix-lib@0.2.5](https://github.com/ethereum/remix/releases/tag/remix-lib@0.2.5) - 29 May 2018 |
||||
|
||||
# Changelog |
||||
|
||||
## remix-lib@0.2.5 (30/04/2018) |
||||
- prepend hex value with 0x [#782](https://github.com/ethereum/remix/pull/782) |
||||
- Retrieve the log from address at the end of a tx execution [#779](https://github.com/ethereum/remix/pull/779) |
||||
- Update eventsDecoder.js [#778](https://github.com/ethereum/remix/pull/778) |
||||
|
||||
[Changes][remix-lib@0.2.5] |
||||
|
||||
|
||||
[v0.1.21]: https://github.com/ethereum/remix/compare/v0.1.20...v0.1.21 |
||||
[v0.1.20]: https://github.com/ethereum/remix/compare/v0.1.19...v0.1.20 |
||||
[v0.1.19]: https://github.com/ethereum/remix/compare/v0.1.18...v0.1.19 |
||||
[v0.1.18]: https://github.com/ethereum/remix/compare/v0.1.17...v0.1.18 |
||||
[v0.1.17]: https://github.com/ethereum/remix/compare/v0.1.16...v0.1.17 |
||||
[v0.1.16]: https://github.com/ethereum/remix/compare/v0.1.15...v0.1.16 |
||||
[v0.1.15]: https://github.com/ethereum/remix/compare/v0.1.14...v0.1.15 |
||||
[v0.1.14]: https://github.com/ethereum/remix/compare/v0.1.13...v0.1.14 |
||||
[v0.1.13]: https://github.com/ethereum/remix/compare/v0.1.12...v0.1.13 |
||||
[v0.1.12]: https://github.com/ethereum/remix/compare/v0.1.10...v0.1.12 |
||||
[v0.1.10]: https://github.com/ethereum/remix/compare/v0.1.9...v0.1.10 |
||||
[v0.1.9]: https://github.com/ethereum/remix/compare/v0.1.8...v0.1.9 |
||||
[v0.1.8]: https://github.com/ethereum/remix/compare/v0.1.7...v0.1.8 |
||||
[v0.1.7]: https://github.com/ethereum/remix/compare/v0.1.6...v0.1.7 |
||||
[v0.1.6]: https://github.com/ethereum/remix/compare/v0.1.5...v0.1.6 |
||||
[v0.1.5]: https://github.com/ethereum/remix/compare/v0.1.4...v0.1.5 |
||||
[v0.1.4]: https://github.com/ethereum/remix/compare/v0.1.3...v0.1.4 |
||||
[v0.1.3]: https://github.com/ethereum/remix/compare/v0.1.2...v0.1.3 |
||||
[v0.1.2]: https://github.com/ethereum/remix/compare/v0.1.1...v0.1.2 |
||||
[v0.1.1]: https://github.com/ethereum/remix/compare/v0.1.0...v0.1.1 |
||||
[v0.1.0]: https://github.com/ethereum/remix/compare/remix-lib@0.2.9...v0.1.0 |
||||
[remix-lib@0.2.9]: https://github.com/ethereum/remix/compare/remix-lib@0.2.8...remix-lib@0.2.9 |
||||
[remix-lib@0.2.8]: https://github.com/ethereum/remix/compare/remix-solidity@0.1.8...remix-lib@0.2.8 |
||||
[remix-solidity@0.1.8]: https://github.com/ethereum/remix/compare/remix-lib@0.2.6...remix-solidity@0.1.8 |
||||
[remix-lib@0.2.6]: https://github.com/ethereum/remix/compare/remix-debug@0.0.6...remix-lib@0.2.6 |
||||
[remix-debug@0.0.6]: https://github.com/ethereum/remix/compare/remix-lib@0.2.5...remix-debug@0.0.6 |
||||
[remix-lib@0.2.5]: https://github.com/ethereum/remix/tree/remix-lib@0.2.5 |
||||
|
||||
<!-- Generated by changelog-from-release --> |
||||
@ -0,0 +1,17 @@ |
||||
# Contributing |
||||
|
||||
Everyone is very welcome to contribute on the codebase of Remix. Please reach us in [Gitter](https://gitter.im/ethereum/remix) in case of any queries. |
||||
|
||||
## Development |
||||
Remix libraries work closely with [Remix IDE](https://remix.ethereum.org). Each library has a readme to explain its application. |
||||
|
||||
When you add a code in any library, please ensure you add related tests. You can visit [here](https://github.com/ethereum/remix-ide#installation) to test your changes by linking the remix libraries with Remix IDE. |
||||
|
||||
## Coding style |
||||
|
||||
Please conform to [standard](https://standardjs.com/) for code styles. |
||||
|
||||
## Submitting Pull Request |
||||
Please follow Github's standard model of making changes & submitting pull request which is very well explained [here](https://guides.github.com/activities/forking/). Make sure your code works fine locally before submitting a pull request. |
||||
|
||||
|
||||
@ -0,0 +1,21 @@ |
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2016-2018 Contributors |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
@ -0,0 +1,35 @@ |
||||
# Remix |
||||
|
||||
[](https://gitter.im/ethereum/remix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
||||
[](https://circleci.com/gh/ethereum/remix/tree/master) |
||||
[](https://remix-ide.readthedocs.io/en/latest/index.html) |
||||
|
||||
|
||||
**Remix** is a suite of tools that helps smart contract development, compilation, testing & deployment. These tools also works as a core of native plugins of Remix IDE. |
||||
|
||||
**Remix IDE** is an IDE for Solidity dApp developers, powered by Remix. The Remix IDE repository is available **[here](https://github.com/ethereum/remix-ide)**, and an online version is available at https://remix.ethereum.org. |
||||
|
||||
For more, check out the [Remix IDE documentation](https://remix-ide.readthedocs.io/en/latest/index.html). |
||||
|
||||
## Remix Modules |
||||
|
||||
Remix is built out of several different modules. Here is the brief description. |
||||
|
||||
+ [`remix-analyzer`](remix-analyzer/README.md): Perform static analysis on Solidity smart contracts to check security vulnerabilities and bad development practices |
||||
+ [`remix-astwalker`](remix-tests/README.md): Parse solidity AST (Abstract Syntax Tree) |
||||
+ [`remix-debug`](remix-debug/README.md): Debug Ethereum transactions. It provides several controls that allow stepping over the trace and seeing the current state of a selected step. |
||||
+ [`remix-solidity`](remix-solidity/README.md): Load a Solidity compiler from provided URL and compile the contract using loaded compiler and return the compilation details |
||||
+ [`remix-lib`](remix-lib/README.md): Common place for libraries being used across multiple modules |
||||
+ [`remix-tests`](remix-tests/README.md): Unit test Solidity smart contracts. It works as a plugin & as CLI both |
||||
+ [`remix-url-resolver`](remix-url-resolver/README.md): Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.). |
||||
+ [`remixd`](https://github.com/ethereum/remixd/tree/master): Allow accessing local filesystem from Remix IDE by running a daemon |
||||
|
||||
Each module generally has their own npm package and test suite, as well as basic documentation in their respective `README`s. Usage of modules as plugin is well documented **[here](https://remix-ide.readthedocs.io/en/latest/index.html)**. |
||||
|
||||
## Contributing |
||||
|
||||
Everyone is very welcome to contribute on the codebase of Remix. Please reach us in [Gitter](https://gitter.im/ethereum/remix) in case of any query/feedback/suggestion. |
||||
|
||||
For more information on the contributing procedure, see [CONTRIBUTING.md](CONTRIBUTING.md). |
||||
|
||||
|
||||
@ -0,0 +1,216 @@ |
||||
# 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."
|
||||
@ -0,0 +1,305 @@ |
||||
# -*- 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 = [] |
||||
|
||||
# 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-ide/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 |
||||
|
||||
from recommonmark.parser import CommonMarkParser |
||||
source_suffix = ['.rst', '.md'] |
||||
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) |
||||
@ -0,0 +1,4 @@ |
||||
Remix documentation has moved! |
||||
=============================== |
||||
|
||||
Please go to `remix-ide.readthedocs.io <http://remix-ide.readthedocs.io>`__ |
||||
@ -0,0 +1,263 @@ |
||||
@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 |
||||
@ -0,0 +1,216 @@ |
||||
# 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."
|
||||
@ -0,0 +1,27 @@ |
||||
Analysis |
||||
======== |
||||
|
||||
This section gives information about the last compilation. |
||||
By default, a new analysis is run at each compilation. |
||||
|
||||
The analysis tab gives detailed information about the contract code. It can help you avoid code mistakes and to enforce best practices. |
||||
|
||||
.. image:: images/remix_analysistab.png |
||||
|
||||
Here is the list of analyzers: |
||||
|
||||
- Security: |
||||
- Transaction origin: Warns if tx.origin is used |
||||
- Check effects: Avoid potential reentrancy bugs |
||||
- Inline assembly: Use of Inline Assembly |
||||
- Block timestamp: Semantics maybe unclear |
||||
- Low level calls: Semantics maybe unclear |
||||
- Block.blockhash usage: Semantics maybe unclear |
||||
|
||||
- Gas & Economy: |
||||
- Gas costs: Warns if the gas requirements of the functions are too high |
||||
- This on local calls: Invocation of local functions via this |
||||
|
||||
- Miscellaneous: |
||||
- Constant functions: Checks for potentially constant functions |
||||
- Similar variable names: Checks if variable names are too similar |
||||
@ -0,0 +1,20 @@ |
||||
Compiling contracts |
||||
=================== |
||||
|
||||
By default Remix triggers a compilation each time the current file is changed or another file is selected. |
||||
If the contract has a lot of dependencies and takes a long time to compile, it is possible to disable the `autocompilation`. |
||||
|
||||
.. image:: images/remix_compiletab.png |
||||
|
||||
After each compilation, a list is updated with all the newly compiled contracts. |
||||
|
||||
`Details` modal dialog displays detailed information about the current selected contract. |
||||
|
||||
From this tab, you can also publish your contract to Swarm (only non abstract contracts can be published). |
||||
|
||||
Published data notably contains the ``abi`` and 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 very valuable when addressing reported issues even if the compiler doesn't complain. |
||||
(see :doc:`../analysis_tab`) |
||||
@ -0,0 +1,283 @@ |
||||
# -*- 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 = [] |
||||
|
||||
# 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'] |
||||
source_suffix = '.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' |
||||
copyright = u'2017, yann300' |
||||
author = u'yann300' |
||||
|
||||
# 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' |
||||
|
||||
# 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 = 'alabaster' |
||||
|
||||
# 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 |
||||
@ -0,0 +1,11 @@ |
||||
Debugging |
||||
========= |
||||
|
||||
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). |
||||
|
||||
.. image:: images/remix_debuggertab.png |
||||
|
||||
For more information about debugging, click on the following link: |
||||
:doc:`../tutorial_debug` |
||||
@ -0,0 +1,37 @@ |
||||
File Explorer |
||||
============= |
||||
|
||||
The file explorer lists by default all the files stored in your browser. You can see them in the `browser` folder. You can always rename, remove or add new files to the file explorer. |
||||
|
||||
.. image:: images/remix_file_explorer_browser.png |
||||
|
||||
Note that clearing the browser storage will permanently delete all the solidity files you wrote. To avoid this, you can use Remixd, which enables you to store and sync files in the browser with your local computer (for more information see :doc:`../tutorial_remixd_filesystem`) |
||||
|
||||
.. image:: images/remix_file_explorer_menu.png |
||||
|
||||
We will start by reviewing at the icons at the top left - from left to the right: |
||||
|
||||
Create new File |
||||
--------------- |
||||
|
||||
Creates a new file in the `browser` explorer. |
||||
|
||||
Add Local File |
||||
-------------- |
||||
|
||||
Allows you to select files from the local file system and import them to the Remix browser storage. |
||||
|
||||
Publish to Gist |
||||
--------------- |
||||
|
||||
Publishes files from the browser storage to an anonymous public gist. |
||||
|
||||
Copy to another instance |
||||
------------------------ |
||||
|
||||
Enables you to copy files from the browser storage to another instance (URL) of Remix. |
||||
|
||||
Connect to Localhost |
||||
-------------------- |
||||
|
||||
Allows to use file located in your file system (see :doc:`../tutorial_remixd_filesystem`). |
||||
|
After Width: | Height: | Size: 302 KiB |
|
After Width: | Height: | Size: 196 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 196 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 111 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 201 KiB |
|
After Width: | Height: | Size: 304 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 336 KiB |
|
After Width: | Height: | Size: 195 KiB |
@ -0,0 +1,60 @@ |
||||
Remix - Solidity IDE |
||||
==================== |
||||
|
||||
Remix is an IDE for the smart contract programming language Solidity and has |
||||
an integrated debugger and testing environment. |
||||
|
||||
An up to date online version is available at `remix.ethereum.org <http://remix.ethereum.org>`_ |
||||
|
||||
This page will host documentation and tutorial about features Remix provides. |
||||
|
||||
Please go to `solidity.readthedocs.io <http://solidity.readthedocs.io>`_ for any information regarding ``Solidity`` |
||||
|
||||
Overview |
||||
-------- |
||||
|
||||
Remix provides an integrated development environment (IDE) for smart contract development. |
||||
It focuses on the development and deployment of Solidity written smart contracts. |
||||
|
||||
Remix is a good solution if you intend to: |
||||
|
||||
- Develop smart contracts (remix integrates a solidity editor). |
||||
- Debug a smart contract's execution. |
||||
- Access the state and properties of already deployed smart contract. |
||||
- Debug already committed transaction. |
||||
- Analyze solidity code to reduce coding mistakes and to enforce best practices. |
||||
- Together with Mist (or any tool which inject web3), Remix can be used to test and debug a Dapp (see :doc:`../tutorial_mist`) |
||||
|
||||
Developing smart contract requires a deep understanding of the associated Blockchain technology. |
||||
|
||||
!! Don't use Remix against a production network unless you are completely sure what you are doing !! |
||||
|
||||
This documentation describes all the features remix provides. |
||||
The GUI can be separated in 4 parts. Click on one the link to get more information. |
||||
|
||||
- :doc:`../file_explorer` |
||||
- :doc:`../solidity_editor` |
||||
- :doc:`../terminal` |
||||
- :doc:`../tabs_panel` |
||||
- :doc:`../compile_tab` |
||||
- :doc:`../run_tab` |
||||
- :doc:`../settings_tab` |
||||
- :doc:`../debugger_tab` |
||||
- :doc:`../analysis_tab` |
||||
- :doc:`../support_tab` |
||||
|
||||
Quick Start |
||||
----------- |
||||
|
||||
(see :doc:`../quickstart_javascriptvm`) |
||||
|
||||
Tutorial |
||||
-------- |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 1 |
||||
|
||||
tutorial_remixd_filesystem.rst |
||||
tutorial_mist.rst |
||||
tutorial_debug.rst |
||||
tutorial_import.rst |
||||
@ -0,0 +1,263 @@ |
||||
@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 |
||||
|
After Width: | Height: | Size: 7.9 KiB |
@ -0,0 +1,86 @@ |
||||
Quick Start using the JavaScript VM |
||||
=================================== |
||||
|
||||
There are 3 type of environments Remix can be plugged to: ``Javascript VM``, ``Injected provider``, or ``Web3 provider``. (see :doc:`../run_tab`) |
||||
|
||||
Both ``Web3 provider`` and ``Injected provider`` require the use of an external tool. |
||||
|
||||
The external tool for ``Web3 provider`` is an Ethereum node the tools for ``Injected provider`` are Mist or Metamask. |
||||
|
||||
The ``JavaScript VM`` mode is convenient because each execution runs in your browser. |
||||
Thus reloading the page will restart Remix with an empty state. |
||||
|
||||
So for performance purposes, 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 |
||||
--------------- |
||||
|
||||
.. code-block:: none |
||||
|
||||
pragma solidity ^0.4.16; |
||||
contract testContract { |
||||
|
||||
uint value; |
||||
function testContract(uint _p) { |
||||
value = _p; |
||||
} |
||||
|
||||
function setP(uint _n) payable { |
||||
value = _n; |
||||
} |
||||
|
||||
function setNP(uint _n) { |
||||
value = _n; |
||||
} |
||||
|
||||
function get () constant 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 :doc:`../compile_tab`). |
||||
|
||||
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. |
||||
|
||||
.. image:: images/remix_quickstart_javascriptvm_creation.png |
||||
|
||||
The constructor of ``testContract`` needs a parameter (of type ``uint``). Give any value and click on ``Create``. |
||||
|
||||
The transaction which deploys the instance of ``testContract`` 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``. |
||||
|
||||
.. image:: images/remix_quickstart_javascriptvm_creationTransaction.png |
||||
|
||||
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 action) : it is possible to send value (Ether) to the contract. |
||||
|
||||
``SetPN`` is not payable (light red action) : it is not possible to send value (Ether) to the contract. |
||||
|
||||
Clicking on ``get`` will not execute a transaction (blue action). It is not necessary to do so because ``get`` does not modify the state (variable ``value``) of this instance. |
||||
|
||||
As ``get`` is ``constant`` you can see the return value just below the action. |
||||
|
||||
.. image:: images/remix_quickstart_javascriptvm_callinginstance.png |
||||
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 198 KiB |
|
After Width: | Height: | Size: 210 KiB |
|
After Width: | Height: | Size: 203 KiB |
|
After Width: | Height: | Size: 213 KiB |
|
After Width: | Height: | Size: 192 KiB |
|
After Width: | Height: | Size: 269 KiB |
|
After Width: | Height: | Size: 268 KiB |
|
After Width: | Height: | Size: 287 KiB |
|
After Width: | Height: | Size: 265 KiB |
|
After Width: | Height: | Size: 283 KiB |
|
After Width: | Height: | Size: 266 KiB |
|
After Width: | Height: | Size: 265 KiB |
|
After Width: | Height: | Size: 270 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 266 KiB |
|
After Width: | Height: | Size: 249 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 14 KiB |
@ -0,0 +1,251 @@ |
||||
Running transactions |
||||
==================== |
||||
|
||||
The Run tab is an important section of Remix. It allows you to send transactions to the current environment. |
||||
|
||||
.. image:: images/remix_runtab.png |
||||
|
||||
Run Setup |
||||
--------- |
||||
|
||||
The following settings allow you to directly influence the transaction execution: |
||||
|
||||
- Environment: |
||||
- ``JavaScript VM``: All the transactions will be executed in a sandbox blockchain in the browser. This means nothing will be persisted and a page reload will restart a new blockchain from scratch, the old one will not be saved. |
||||
|
||||
- ``Injected Provider``: Remix will connect to an injected web3 provider. ``Mist`` and ``Metamask`` are example of providers that inject web3, thus can be used with this option. |
||||
|
||||
- ``Web3 Provider``: Remix will connect to a remote node. You will need to provide the URL address to the selected provider: geth, parity or any Ethereum client. |
||||
|
||||
- Account: the list of accounts associated with the current environment (and their associated balances). |
||||
- Gas Limit: the maximum amount of gas that can be set for all the transactions created in Remix. |
||||
- Value: the amount of value for the next created transaction (this value is always reset to 0 after each transaction execution). |
||||
|
||||
.. image:: images/remix_runtab_example.png |
||||
|
||||
Initiate Instance |
||||
----------------- |
||||
|
||||
This section contains the list of compiled contracts and 2 actions: |
||||
|
||||
- ``At Address`` assumes the given address is an instance of the selected contract. It is then possible to interact with an already deployed contract. There's no check at this point, so be careful when using this feature, and be sure you trust the contract at that address. |
||||
|
||||
- ``Create`` send a transaction that deploys the selected contract. When the transaction is mined, the newly created instance will be added (this might take several seconds). Note that if the ``constructor`` has parameters, you need to specify them. |
||||
|
||||
Pending Instances |
||||
----------------- |
||||
|
||||
Validating a transaction take several seconds. During this time, the GUI shows it in a pending mode. When transaction is mined the number of pending transactions is updated |
||||
and the transaction is added to the log (see :doc:`../terminal`) |
||||
|
||||
Instance List |
||||
------------- |
||||
|
||||
This section contains a list of instances to interact with. |
||||
|
||||
Several cases apply: |
||||
- The called function is declared as ``constant`` or ``pure`` in Solidity. The action has a blue background, clicking it does not create a new transaction. Clicking it is not necessary because there are not state changes - but it will update the return value of the function. |
||||
|
||||
- The called function has no special keywords. The action has a light red background, clicking on does create a new transaction. But this transaction cannot accept any amount of Ether. |
||||
|
||||
- The called function is declared as ``payable`` in Solidity. The action has a red background, clicking it does create a new transaction and this transaction can accept value. |
||||
|
||||
For more information about Solidity modifier, see `Solidity modifier <http://solidity.readthedocs.io/en/develop/miscellaneous.html?highlight=pure#modifiers>`_ . |
||||
|
||||
If a function requires input parameters, it is required to specify them. |
||||
|
||||
USING ABI |
||||
--------- |
||||
|
||||
Using ``Create`` or ``At Address`` is a classic use case of Remix. It is possible though to interact with a contract by using its ABI. The ABI is a JSON array which describe its interface. |
||||
|
||||
To interact with a contract using the ABI, create a new file in Remix with extension ``*.abi`` and copy the ABI content to it. |
||||
Then in the input next to ``At Address``, put the Address of the contract you want to interact with. Click on ``At Address``, |
||||
a new "connection" with the contract will popup below. |
||||
|
||||
USING THE RECORDER |
||||
------------------ |
||||
|
||||
The Recorder allows to save a bunch of transactions in a JSON file and rerun them later either in the same environment or in another. |
||||
|
||||
Saving to JSON allows to easily check the transaction list, tweak input parameters, change linked library, etc... |
||||
|
||||
We can find many use cases for the recorder, for instance: |
||||
- After having coded and tested contracts in a constrained environment (like the JavaScript VM), it could be interesting to redeploy them easily in a more persisted environment (like a Geth node) in order to check whether everything behaves normally in a classic environment. |
||||
- Deploying contract does often require more than creating one transaction. |
||||
- Working in a dev environment does often require to setup the state in a first place. |
||||
|
||||
|
||||
.. image:: images/remix_recorder.png |
||||
|
||||
Saving a record ends up with the creation of this type of content (see below): |
||||
|
||||
In that specific record, 3 transactions are executed: |
||||
|
||||
The first corresponds to the deployment of the lib ``testLib``. |
||||
|
||||
The second corresponds to the deployment of the contract ``test``, the first parameter of the constructor is set to 11. |
||||
That contract depends on a library. The linkage is done using the property ``linkReferences``. |
||||
In that case we use the addres of the previously created library : ``created{1512830014773}``. the number is |
||||
the id (timestamp) of the transaction that leads to the creation of the library. |
||||
|
||||
The third parameter corresponds to the call to te function ``set`` of the contract ``test`` (the property to is set to: ``created{1512830015080}``) . Input parameters are ``1`` and ``0xca35b7d915458ef540ade6068dfe2f44e8fa733c`` |
||||
|
||||
all these transactions are created using the value of the accounts ``account{0}``. |
||||
|
||||
.. code-block:: none |
||||
|
||||
{ |
||||
"accounts": { |
||||
"account{0}": "0xca35b7d915458ef540ade6068dfe2f44e8fa733c" |
||||
}, |
||||
"linkReferences": { |
||||
"testLib": "created{1512830014773}" |
||||
}, |
||||
"transactions": [ |
||||
{ |
||||
"timestamp": 1512830014773, |
||||
"record": { |
||||
"value": "0", |
||||
"parameters": [], |
||||
"abi": "0xbc36789e7a1e281436464229828f817d6612f7b477d66591ff96a9e064bcc98a", |
||||
"contractName": "testLib", |
||||
"bytecode": "60606040523415600e57600080fd5b60968061001c6000396000f300606060405260043610603f576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680636d4ce63c146044575b600080fd5b604a6060565b6040518082815260200191505060405180910390f35b6000610d809050905600a165627a7a7230582022d123b15248b8176151f8d45c2dc132063bcc9bb8d5cd652aea7efae362c8050029", |
||||
"linkReferences": {}, |
||||
"type": "constructor", |
||||
"from": "account{0}" |
||||
} |
||||
}, |
||||
{ |
||||
"timestamp": 1512830015080, |
||||
"record": { |
||||
"value": "100", |
||||
"parameters": [ |
||||
11 |
||||
], |
||||
"abi": "0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec", |
||||
"contractName": "test", |
||||
"bytecode": "60606040526040516020806102b183398101604052808051906020019091905050806000819055505061027a806100376000396000f300606060405260043610610062576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680632f30c6f61461006757806338cc48311461009e57806362738998146100f357806387cc10e11461011c575b600080fd5b61009c600480803590602001909190803573ffffffffffffffffffffffffffffffffffffffff16906020019091905050610145565b005b34156100a957600080fd5b6100b1610191565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b34156100fe57600080fd5b6101066101bb565b6040518082815260200191505060405180910390f35b341561012757600080fd5b61012f6101c4565b6040518082815260200191505060405180910390f35b8160008190555080600160006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055505050565b6000600160009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b60008054905090565b600073__browser/ballot.sol:testLib____________636d4ce63c6000604051602001526040518163ffffffff167c010000000000000000000000000000000000000000000000000000000002815260040160206040518083038186803b151561022e57600080fd5b6102c65a03f4151561023f57600080fd5b505050604051805190509050905600a165627a7a72305820e0b2510bb2890a0334bfe5613d96db3e72442e63b514cdeaee8fc2c6bbd19d3a0029", |
||||
"linkReferences": { |
||||
"browser/ballot.sol": { |
||||
"testLib": [ |
||||
{ |
||||
"length": 20, |
||||
"start": 511 |
||||
} |
||||
] |
||||
} |
||||
}, |
||||
"name": "", |
||||
"type": "constructor", |
||||
"from": "account{0}" |
||||
} |
||||
}, |
||||
{ |
||||
"timestamp": 1512830034180, |
||||
"record": { |
||||
"value": "1000000000000000000", |
||||
"parameters": [ |
||||
1, |
||||
"0xca35b7d915458ef540ade6068dfe2f44e8fa733c" |
||||
], |
||||
"to": "created{1512830015080}", |
||||
"abi": "0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec", |
||||
"name": "set", |
||||
"type": "function", |
||||
"from": "account{0}" |
||||
} |
||||
} |
||||
], |
||||
"abis": { |
||||
"0xbc36789e7a1e281436464229828f817d6612f7b477d66591ff96a9e064bcc98a": [ |
||||
{ |
||||
"constant": true, |
||||
"inputs": [], |
||||
"name": "get", |
||||
"outputs": [ |
||||
{ |
||||
"name": "", |
||||
"type": "uint256" |
||||
} |
||||
], |
||||
"payable": false, |
||||
"stateMutability": "view", |
||||
"type": "function" |
||||
} |
||||
], |
||||
"0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec": [ |
||||
{ |
||||
"constant": true, |
||||
"inputs": [], |
||||
"name": "getInt", |
||||
"outputs": [ |
||||
{ |
||||
"name": "", |
||||
"type": "uint256" |
||||
} |
||||
], |
||||
"payable": false, |
||||
"stateMutability": "view", |
||||
"type": "function" |
||||
}, |
||||
{ |
||||
"constant": true, |
||||
"inputs": [], |
||||
"name": "getFromLib", |
||||
"outputs": [ |
||||
{ |
||||
"name": "", |
||||
"type": "uint256" |
||||
} |
||||
], |
||||
"payable": false, |
||||
"stateMutability": "view", |
||||
"type": "function" |
||||
}, |
||||
{ |
||||
"constant": true, |
||||
"inputs": [], |
||||
"name": "getAddress", |
||||
"outputs": [ |
||||
{ |
||||
"name": "", |
||||
"type": "address" |
||||
} |
||||
], |
||||
"payable": false, |
||||
"stateMutability": "view", |
||||
"type": "function" |
||||
}, |
||||
{ |
||||
"constant": false, |
||||
"inputs": [ |
||||
{ |
||||
"name": "_t", |
||||
"type": "uint256" |
||||
}, |
||||
{ |
||||
"name": "_add", |
||||
"type": "address" |
||||
} |
||||
], |
||||
"name": "set", |
||||
"outputs": [], |
||||
"payable": true, |
||||
"stateMutability": "payable", |
||||
"type": "function" |
||||
}, |
||||
{ |
||||
"inputs": [ |
||||
{ |
||||
"name": "_r", |
||||
"type": "uint256" |
||||
} |
||||
], |
||||
"payable": true, |
||||
"stateMutability": "payable", |
||||
"type": "constructor" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
@ -0,0 +1,13 @@ |
||||
Settings |
||||
======== |
||||
|
||||
This section displays the current compiler version and allows one to change to another version. |
||||
|
||||
.. image:: images/remix_settingstab.png |
||||
|
||||
Settings, available here: |
||||
|
||||
- Text wrap: controls if the text in the editor should be wrapped. |
||||
- Enable optimization: defines if the compiler should enable optimization during compilation. Enabling this option saves execution gas. |
||||
It is useful to enable optimization for contracts ready to be deployed in production |
||||
but could lead to some inconsistencies when debugging such a contract. |
||||
@ -0,0 +1,13 @@ |
||||
Solidity Editor |
||||
=============== |
||||
|
||||
The Remix editor recompiles the code each time the current file is changed or another file is selected. It also provides syntax highlighting mapped to solidity keywords. |
||||
|
||||
.. image:: images/remix_editor.png |
||||
|
||||
Here's the list of some important features: |
||||
|
||||
- It display opened files as tabs. |
||||
- Compilation Warning and Error are displayed in the gutter |
||||
- Remix saves the current file continuously (5s after the last changes) |
||||
- +/- on the top left corner enable you to increase/decrease the font size of the editor |
||||
@ -0,0 +1,6 @@ |
||||
Support |
||||
======= |
||||
|
||||
This section provides a link to Remix Issues where users can report a bug or suggest a feature, as well as providing other useful links. It also displays a `Remix developers' channel <http://gitter.im/ethereum/remix>`_ |
||||
|
||||
.. image:: images/remix_supporttab.png |
||||
@ -0,0 +1,9 @@ |
||||
Tabs Panel |
||||
========== |
||||
|
||||
- :doc:`../compile_tab` |
||||
- :doc:`../run_tab` |
||||
- :doc:`../settings_tab` |
||||
- :doc:`../debugger_tab` |
||||
- :doc:`../analysis_tab` |
||||
- :doc:`../support_tab` |
||||
@ -0,0 +1,14 @@ |
||||
Terminal |
||||
======== |
||||
|
||||
.. image:: images/remix_terminal.png |
||||
|
||||
Features, available in the terminal: |
||||
|
||||
- It integrates a JavaScript interpreter and the ``web3`` object. It enables the execution of the JavaScript script which interacts with the current context. (note that ``web3`` is only available if the ``web provider`` or ``injected provider`` mode is selected). |
||||
|
||||
- It displays important actions made while interacting with the Remix IDE (i.e. sending a new transaction). |
||||
|
||||
- It displays transactions that are mined in the current context. You can choose to display all transactions or only transactions that refers to the contracts Remix knows (e.g transaction created from the Remix IDE). |
||||
|
||||
- It allows searching for the data and clearing the logs from the terminal. |
||||
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 117 KiB |
@ -0,0 +1,204 @@ |
||||
Debugging a Transaction |
||||
======================= |
||||
|
||||
.. _tutorial-debug: |
||||
|
||||
The goal of this tutorial is to explain how to debug transaction using Remix. |
||||
|
||||
Start debugging |
||||
--------------- |
||||
|
||||
There are two different ways to start debugging, each way correspond to a different use case. |
||||
|
||||
From the Transaction GUI |
||||
~~~~~~~~~~~~~~~~~~~~~~~~ |
||||
|
||||
We will not explain in detail here how to write or deploy contract. |
||||
Let us start with a basic contract (replace this one by your's): |
||||
|
||||
.. code-block:: none |
||||
|
||||
contract Donation { |
||||
address owner; |
||||
event fundMoved(address _to, uint _amount); |
||||
modifier onlyowner { if (msg.sender == owner) _; } |
||||
address[] _giver; |
||||
uint[] _values; |
||||
|
||||
function Donation() { |
||||
owner = msg.sender; |
||||
} |
||||
|
||||
function donate() payable { |
||||
addGiver(msg.value); |
||||
} |
||||
|
||||
function moveFund(address _to, uint _amount) onlyowner { |
||||
uint balance = this.balance; |
||||
uint amount = _amount; |
||||
if (_amount <= this.balance) { |
||||
if (_to.send(this.balance)) { |
||||
fundMoved(_to, _amount); |
||||
} else { |
||||
throw; |
||||
} |
||||
} else { |
||||
throw; |
||||
} |
||||
} |
||||
|
||||
function addGiver(uint _amount) internal { |
||||
_giver.push(msg.sender); |
||||
_values.push(_amount); |
||||
} |
||||
} |
||||
|
||||
For the purpose of this tutorial, we will run the ``JavaScript VM`` (that's the default mode when you don't use Remix with Mist or Metamask). This simulates a custom blockchain. You could do the same using a proper backend node. |
||||
|
||||
Now, let's deploy the contract: |
||||
|
||||
Right panel / Red button ``Create`` |
||||
|
||||
.. image:: remix1.png |
||||
|
||||
Then we should call the ``Donate`` function (that will send Ether to the contract). |
||||
|
||||
Let's set the amount of Ether: |
||||
|
||||
Right panel / second tab from the left - fill in the ´´value´´ input (´1 ether´ for instance) |
||||
|
||||
.. image:: remix_valueinput.png |
||||
|
||||
Then click on ``Donate``. As we are using the ``JavaScript VM``, everything goes almost instantly. |
||||
|
||||
Remix displays also some information related to each transaction result. In the terminal, the transaction is logged and you can start debugging it. |
||||
|
||||
.. image:: remix_startdebugging.png |
||||
|
||||
From the Debugger |
||||
~~~~~~~~~~~~~~~~~ |
||||
|
||||
The debugger can be found in the right panel / 5th tab from the left. |
||||
|
||||
You can start a debug session by providing either a ``transaction hash`` or a ``block number`` and ``transaction index``. |
||||
|
||||
.. image:: remix3.png |
||||
|
||||
Click the ``play`` button to start debugging. |
||||
|
||||
Using the debugger |
||||
------------------ |
||||
|
||||
The debugger allows one to see detailed informations about the transaction's execution. It uses the editor (left panel) to display the location |
||||
in the source code where the current execution is. |
||||
|
||||
The transaction panel displays basic information about the current transaction. |
||||
|
||||
.. image:: remix_debugtransactioninfo.png |
||||
|
||||
The navigation part contains a slider and buttons that can be used to step through the transaction execution. |
||||
|
||||
From the left to the right: |
||||
|
||||
step over back, step into back, step into forward, step over forward, jump out (jump out of the current call), jump to the previous breakpoint, jump to the next breakpoint. |
||||
|
||||
.. image:: remix_navigation.png |
||||
|
||||
11 panels give detailed information about the execution: |
||||
|
||||
Instructions |
||||
~~~~~~~~~~~~ |
||||
|
||||
.. image:: remix_debuginstructions.png |
||||
|
||||
The Instructions panel displays the bytecode of the current executing contract- with the current step highlighted. |
||||
|
||||
Important note: |
||||
When this panel is hidden, the slider will have a courser granularity and only stop at expression boundaries, even if they are compiled into multiple EVM instructions. |
||||
When the panel is displayed, it will be possible to step over every instruction, even those that refers to the same expression. |
||||
|
||||
Solidity Locals |
||||
~~~~~~~~~~~~~~~ |
||||
|
||||
.. image:: remix_soliditylocals.png |
||||
|
||||
The Solidity Locals panel displays local variables associated with the current context. |
||||
|
||||
Solidity State |
||||
~~~~~~~~~~~~~~ |
||||
|
||||
.. image:: remix_soliditystate.png |
||||
|
||||
The Solidity State panel displays state variables of the current executing contract. |
||||
|
||||
Low level panels |
||||
~~~~~~~~~~~~~~~~ |
||||
|
||||
These panels display low level informations about the execution: |
||||
|
||||
- Stack |
||||
- Storages Changes |
||||
- Memory |
||||
- Call Data |
||||
- Call Stack |
||||
- Return Value (only if the current step is a RETURN opcode) |
||||
- Full Storages Changes (only at the end of the execution - display every storage change of every modified contract) |
||||
|
||||
Reverted Transaction |
||||
~~~~~~~~~~~~~~~~~~~~ |
||||
|
||||
A transaction could be reverted (either because of out of gas exception, Solidity ``throw`` or low level exception). |
||||
|
||||
In that case it is important to be aware of the exception and to locate where the exception is in the source code. |
||||
|
||||
Remix will warn you when the execution throws an exception. The ``warning`` button will jump to the last opcode before the exception happened. |
||||
|
||||
.. image:: remix_executionexception.png |
||||
|
||||
Breakpoints |
||||
~~~~~~~~~~~ |
||||
|
||||
The two last buttons from the navigation area are used to jump either back to the previous breakpoint or forward to the next breakpoint. |
||||
|
||||
Breakpoints can be added and removed by clicking on the line number. |
||||
|
||||
.. image:: remix_breakpoint.png |
||||
|
||||
When a debug session is started, the execution will jump to the first encountered breakpoint. |
||||
|
||||
Important note: |
||||
If you add a breakpoint to a line that declares a variable, it might be triggered twice: Once for initializing the |
||||
variable to zero and second time for assigning the actual value. |
||||
As an example, assume you are debugging the following contract: |
||||
|
||||
.. code-block:: none |
||||
|
||||
contract ctr { |
||||
function hid () { |
||||
uint p = 45; |
||||
uint m; |
||||
m = 89; |
||||
uint l = 34; |
||||
} |
||||
} |
||||
|
||||
And let's says that breakpoints are set for the lines |
||||
|
||||
``uint p = 45;`` |
||||
|
||||
``m = 89;`` |
||||
|
||||
``uint l = 34;`` |
||||
|
||||
|
||||
then clicking on ``Jump to next breakpoint`` will stop at the following lines in the given order: |
||||
|
||||
``uint p = 45;`` (declaration of p) |
||||
|
||||
``uint l = 34;`` (declaration of l) |
||||
|
||||
``uint p = 45;`` (45 assigned to p) |
||||
|
||||
``m = 89;`` (89 assigned to m) |
||||
|
||||
``uint l = 34;`` (34 assigned to l) |
||||
@ -0,0 +1,35 @@ |
||||
Importing Source Files in Solidity |
||||
================================== |
||||
|
||||
.. _tutorial-import: |
||||
|
||||
This tutorial will show you how to import local and external files. |
||||
|
||||
The compilation result will also contain contracts implemented in the imported files. |
||||
|
||||
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>`_ |
||||
|
||||
Importing a local file |
||||
---------------------- |
||||
|
||||
Other files in Remix can be imported just by specifying their path. |
||||
Please use `./` for relative paths to increase portability. |
||||
|
||||
.. image:: tuto_basicimport.png |
||||
|
||||
Importing from Github |
||||
---------------------- |
||||
|
||||
It is possible to import files directly from github with URLs like |
||||
``https://github.com/<owner>/<repo>/<path to the file>``. |
||||
|
||||
.. image:: tuto_importgit.png |
||||
|
||||
Importing from Swarm |
||||
-------------------- |
||||
|
||||
Files can be imported using all URLs supported by swarm. If you do not have a swarm |
||||
node, swarm-gateways.net will be used instead. |
||||
|
||||
.. image:: tuto_importswarm.png |
||||
@ -0,0 +1,289 @@ |
||||
Debugging a Dapp using Remix - Mist - Geth |
||||
=================================================== |
||||
|
||||
.. _tutorial-mist-geth: |
||||
|
||||
The ultimate goal of this tutorial is to debug transactions that have been created by a dapp front end. |
||||
|
||||
It is easy in Remix to debug a transaction created from its own GUI. However, setting up an environment that allows you to |
||||
debug transactions created outside of Remix, require a bit more of complexity. |
||||
|
||||
We will need four tools for that : |
||||
|
||||
- Geth - this is the center piece and provides the blockchain environment. We will basically run geth in a `dev` mode. |
||||
|
||||
- Mist - this is the Ethereum dapp browser. We will use it to browse our front end. |
||||
|
||||
- Remix - this is the Ethereum IDE. We will use it to develop our Solidity contract. |
||||
|
||||
- Any code editor you want - in order to write your front end :) |
||||
|
||||
Install the environment |
||||
----------------------- |
||||
|
||||
Install Mist |
||||
~~~~~~~~~~~~ |
||||
|
||||
Mist is the Ethereum browser and the entry point of a Dapp. |
||||
|
||||
Please download `the latest version <http://github.com/ethereum/mist/releases>`_ (at least 0.8.9). |
||||
|
||||
Basically we will always run our front end in Mist (note that it is also possible to use `Metamask <http://metamask.io>`_). |
||||
|
||||
Install Geth |
||||
~~~~~~~~~~~~ |
||||
|
||||
`Geth <http://github.com/ethereum/go-ethereum/releases>`_ is the official Ethereum client. |
||||
|
||||
Running the environment |
||||
----------------------- |
||||
|
||||
Run Geth |
||||
~~~~~~~~ |
||||
|
||||
We will run a test node. This node will have a new empty state and will not be synced to the main or ropsten network. |
||||
|
||||
:: |
||||
|
||||
geth --ipcpath <test-chain-directory>/geth.ipc --datadir <test-chain-directory> --dev console |
||||
|
||||
|
||||
``<test-chain-directory>`` is the folder where keys and chain data will be stored. |
||||
|
||||
``--ipcpath`` defines the end point that other apps (like Mist) use to talk to geth. |
||||
|
||||
``--datadir`` specifies the data directory. |
||||
|
||||
``--dev`` sets the node into private chain mode and adds some debugging flags. |
||||
|
||||
Then we need to create accounts and mine a bit to generate some Ether: |
||||
|
||||
:: |
||||
|
||||
// from the geth console : |
||||
personal.newAccount() // You can execute this command several time if you need more than one account. |
||||
miner.start() // generate some Ether. |
||||
miner.stop() // stop mining after 30s-60s - we could also keep mining. |
||||
|
||||
Next time we run Geth, we will only need to mine transactions (no need to recreate account). |
||||
|
||||
Run Mist |
||||
~~~~~~~~ |
||||
|
||||
If we run Mist without any argument, its internal Geth node will run. As we have our own we need to specify the ipc path of the node installed above. |
||||
|
||||
:: |
||||
|
||||
mist --rpc <test-chain-directory>/geth.ipc |
||||
|
||||
(yes the option is --rpc) |
||||
|
||||
Once Mist is started, verify that it is connected to the test node (that's very important!!). |
||||
|
||||
On the bottom left, check that the network is ``Private-net`` and that the block number is the same as reported by the test node we are currently running. Run the following command in the Geth Console to check: `web3.eth.blockNumber`. |
||||
|
||||
.. image:: mist1.png |
||||
|
||||
Clicking on `Wallet` will allow you to send transactions and check account balances (if you are currently mining you should see the balance increasing). |
||||
|
||||
Starting Remix |
||||
~~~~~~~~~~~~~~ |
||||
|
||||
In Mist click on ``Develop`` / ``Open Remix IDE`` |
||||
|
||||
Remix will open in a new window. If this is the first time it is run, the ``Ballot`` contract will be loaded. |
||||
|
||||
Now, we need to check if Remix is connected to Mist: |
||||
|
||||
Right panel / third tab from the left, ``Injected Provider`` should be checked. |
||||
|
||||
.. image:: remix4.png |
||||
|
||||
Right panel / second tab from the left, ``Transaction Origin`` should contain accounts we have previously created in Geth. |
||||
|
||||
.. image:: remix5.png |
||||
|
||||
Developing contract / front end |
||||
-------------------------------- |
||||
|
||||
Donation contract - Dapp Back end |
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
||||
|
||||
Here is a sample solidity contract. |
||||
|
||||
Copy and paste the following inside remix: |
||||
|
||||
.. code-block:: none |
||||
|
||||
contract Donation { |
||||
address owner; |
||||
event fundMoved(address _to, uint _amount); |
||||
modifier onlyowner { if (msg.sender == owner) _; } |
||||
address[] _giver; |
||||
uint[] _values; |
||||
|
||||
function Donation() { |
||||
owner = msg.sender; |
||||
} |
||||
|
||||
function donate() payable { |
||||
addGiver(msg.value); |
||||
} |
||||
|
||||
function moveFund(address _to, uint _amount) onlyowner { |
||||
uint balance = this.balance; |
||||
uint amount = _amount; |
||||
if (_amount <= this.balance) { |
||||
if (_to.send(this.balance)) { |
||||
fundMoved(_to, _amount); |
||||
} else { |
||||
throw; |
||||
} |
||||
} else { |
||||
throw; |
||||
} |
||||
} |
||||
|
||||
function addGiver(uint _amount) internal { |
||||
_giver.push(msg.sender); |
||||
_values.push(_amount); |
||||
} |
||||
} |
||||
|
||||
|
||||
Dapp Front end |
||||
~~~~~~~~~~~~~~ |
||||
|
||||
and here is the front end: |
||||
|
||||
.. code-block:: none |
||||
|
||||
<div> |
||||
<div>Donation Contract</div> |
||||
<br/> |
||||
<input id='contractaddress' placeholder='contract address'></intput> |
||||
<br/> |
||||
<div> |
||||
<br/> |
||||
<input id='fromGive' placeholder='from' ></intput><input placeholder='amount' id='valueGive'></intput><button id="fallbackbtn" onclick="donate()">give</button> |
||||
<br/> |
||||
<br/> |
||||
<input id='fromMoveFund' placeholder='from' ></intput><input id='moveFundTo' placeholder='move to' ></intput><input id='amountToMove' placeholder='amount' ></intput><button id="movefundbtn" onclick="movefund()">moveFund</button> |
||||
<br/> |
||||
<br/> |
||||
<div id='wait' ></div> |
||||
</div> |
||||
<br/> |
||||
<br/> |
||||
<div id='log'> |
||||
</div> |
||||
</div> |
||||
|
||||
<script type="text/javascript"> |
||||
function donate () { |
||||
var donation = contractspec.at(document.getElementById('contractaddress').value) |
||||
donation.donate({ |
||||
from: document.getElementById('fromGive').value, |
||||
value: document.getElementById('valueGive').value |
||||
}, function (error, txHash) { |
||||
tryTillResponse(txHash, function (error, receipt) { |
||||
alert('done ' + txHash) |
||||
}) |
||||
}) |
||||
} |
||||
|
||||
function movefund () { |
||||
var donation = contractspec.at(document.getElementById('contractaddress').value) |
||||
donation.moveFund( |
||||
document.getElementById('moveFundTo').value, |
||||
document.getElementById('amountToMove').value, |
||||
function (error, txHash) { |
||||
tryTillResponse(txHash, function (error, receipt) { |
||||
alert('done ' + txHash) |
||||
}) |
||||
}) |
||||
} |
||||
|
||||
var contractspec = web3.eth.contract([{"constant":false,"inputs":[{"name":"_to","type":"address"},{"name":"_amount","type":"uint256"}],"name":"moveFund","outputs":[],"payable":false,"type":"function"},{"constant":false,"inputs":[],"name":"donate","outputs":[],"payable":true,"type":"function"},{"inputs":[],"payable":false,"type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"name":"_to","type":"address"},{"indexed":false,"name":"_amount","type":"uint256"}],"name":"fundMoved","type":"event"}]); |
||||
|
||||
function tryTillResponse (txhash, done) { |
||||
document.getElementById('wait').innerHTML = 'waiting for the transaction to be mined ...' |
||||
web3.eth.getTransactionReceipt(txhash, function (err, result) { |
||||
if (!err && !result) { |
||||
// Try again with a bit of delay |
||||
setTimeout(function () { tryTillResponse(txhash, done) }, 500) |
||||
} else { |
||||
document.getElementById('wait').innerHTML = '' |
||||
var log = document.createElement("div") |
||||
log.innerHTML = JSON.stringify(result) |
||||
document.getElementById('log').appendChild(log) |
||||
done(err,result) |
||||
} |
||||
}) |
||||
} |
||||
</script> |
||||
|
||||
I would suggest serving this file using ``http-serve``, but you can use any web server you like. |
||||
|
||||
Example: Dapp Front End https://github.com/ltfschoen/dapp_front_end |
||||
|
||||
Important notice ! |
||||
~~~~~~~~~~~~~~~~~~ |
||||
|
||||
The variable ``contractspec`` contains the abi of the ``donation`` contract. This means that if you change something in the contract interface (function names, parameters, ...) |
||||
you need to copy the new abi from remix to the front end. |
||||
|
||||
Deploying |
||||
--------- |
||||
|
||||
Right panel / Red button ``Create`` |
||||
|
||||
.. image:: remix1.png |
||||
|
||||
This creates a new transaction that deploys the ``Donation`` contract (Mist will ask for the usual passphrase check). |
||||
|
||||
Wait for the transaction to be mined (don't forget to activate mining ``miner.start()``). |
||||
Once this is done, you can use it by executing the ``moveFund`` and ``donate`` function. But this is not what we |
||||
want to achieve. We want to run and debug those functions from the front end. |
||||
|
||||
Remix also display the address of the contract. Save it, we'll need this address later. |
||||
|
||||
.. image:: remix2.png |
||||
|
||||
Debugging |
||||
--------- |
||||
|
||||
From Mist, browse the above front end. |
||||
In the first field, paste the address of the newly created contract. Now, let's call the first function (label ``give``). |
||||
|
||||
You will need an account and a value. |
||||
|
||||
The account could be any account that is declared in the Wallet section of Mist. This is the sender of the transaction that we are going to create. |
||||
The value should be no more than the actual balance of the account - the unit is in `wei`, so just put ``100`` (100 wei), that should be fine. |
||||
|
||||
Click on ``Give`` and wait for the transaction to be mined. |
||||
|
||||
The HTML block with id ``log`` is filled by all the transactions created from the front end. |
||||
It was easier for the purpose of this tutorial to just log transactions in a div but you can have your own logging mechanism. |
||||
|
||||
There is only one field that we need, this is the ``transactionHash``. |
||||
|
||||
Copy it and switch to Remix. On the right side, the fifth panel shows a small "bug" icon, that is the debugger. |
||||
|
||||
Paste the hash into the transaction field and click on the ``play`` button. |
||||
|
||||
.. image:: remix3.png |
||||
|
||||
You are now entering a debug session for the call to ``donate``. |
||||
|
||||
Debugging in Remix is easier than with common tools like gdb because you can freely move in time. |
||||
Use the slider to change the current step and click on the panels below to expand them and explore the curret state, local variables, etc. |
||||
There are also breakpoints to move between sections of the code quickly, but more on all that later. |
||||
|
||||
|
||||
At the time of this writing, there is an issue that could break the contract creation. |
||||
The a workaround for that at https://github.com/ethereum/go-ethereum/issues/3653 . |
||||
Please follow the workaround or wait for this issue to be closed. |
||||
|
||||
Also, although retrieving a contract's storage when Remix is using the JavaScript VM is working well, |
||||
there is still work to be done when Remix is using eth or geth as backend. |
||||
@ -0,0 +1,37 @@ |
||||
Accessing a shared folder in Remix IDE using Remixd |
||||
=================================================== |
||||
|
||||
.. _tutorial-remixd-filesystem: |
||||
|
||||
Remixd is an npm module. Its purpose is to give the remix web application access to a folder from your local computer. |
||||
|
||||
The code of Remixd can be checked out `here <https://github.com/ethereum/remixd>`_ . |
||||
|
||||
Remixd can be globally installed using the following command: ``npm install -g remixd``. |
||||
|
||||
Then ``remixd -s <absolute-path-to-the-shared-folder>`` will start Remixd and share the given folder. |
||||
|
||||
The folder is shared using a websocket connection between ``Remix IDE`` and ``Remixd``. |
||||
|
||||
Be sure the user executing Remix has read/write permission on the folder. |
||||
|
||||
.. warning:: |
||||
Remixd provides full read and write access to the given folder for any application that can access the TCP port 65520 on your local host. |
||||
|
||||
From ``Remix IDE``, you will need to activate the connection. |
||||
|
||||
Click on the ``localhost connection`` icon: |
||||
|
||||
.. image:: remixd_noconnection.png |
||||
|
||||
A modal dialog will ask confirmation |
||||
|
||||
.. image:: remixd_alert.png |
||||
|
||||
Accepting this dialog will start a session. Once the connection is made, the status will update and the connection icon should shows up in green. |
||||
|
||||
Hovering the icon will give more connection status information. |
||||
|
||||
At this point if the connection is successful, the shared folder will be available in the file explorer. |
||||
|
||||
.. image:: remixd_connectionok.png |
||||
@ -0,0 +1,39 @@ |
||||
#!/usr/bin/env node
|
||||
|
||||
'use strict'; |
||||
const { task } = require('gulp'); |
||||
const fs = require('fs'); |
||||
const util = require('util'); |
||||
const promisifyExec = util.promisify(require('child_process').exec); |
||||
|
||||
var packageJSON = require('./package.json'); |
||||
|
||||
/** |
||||
* @dev Task to create git tag using version from package.json and pushing this specific tag |
||||
*/ |
||||
task('publishTag', async function () { |
||||
const tag = "v" + packageJSON.version |
||||
await promisifyExec(`git tag ${tag}; git push origin ${tag}`); |
||||
}); |
||||
|
||||
/** |
||||
* @dev Task to update changelog for latest release |
||||
*/ |
||||
task('updateChangelog', async function () { |
||||
const previous_version = process.argv[4]; |
||||
const next_version = "v" + packageJSON.version; |
||||
|
||||
// Create changes.md with latest release changelog temporarily
|
||||
await promisifyExec(`github-changes -o ethereum -r remix -a --file changes.md --only-pulls --use-commit-body --only-merges --between-tags ${previous_version} ... ${next_version}`); |
||||
const latestChangelog = fs.readFileSync(__dirname + '/changes.md', 'utf8') |
||||
const oldChangelog = fs.readFileSync(__dirname + '/CHANGELOG.md', 'utf8') |
||||
// Concatenate latest changelog content to the top of old changelog file content
|
||||
const data = latestChangelog + '\n\n' + oldChangelog |
||||
// Delete current changelog file CHANGELOG.md
|
||||
fs.unlinkSync(__dirname + '/CHANGELOG.md'); |
||||
// Delete changes.md
|
||||
fs.unlinkSync(__dirname + '/changes.md'); |
||||
// Write the concatenated content to CHANGELOG.md (We delete and create file to place the new data on top)
|
||||
fs.writeFileSync(__dirname + '/CHANGELOG.md', data);
|
||||
await Promise.resolve(); |
||||
}); |
||||
@ -0,0 +1,23 @@ |
||||
{ |
||||
"lerna": "2.10.2", |
||||
"packages": [ |
||||
"remix-debug", |
||||
"remix-lib", |
||||
"remix-solidity", |
||||
"remix-analyzer", |
||||
"remix-tests", |
||||
"remix-simulator", |
||||
"remix-url-resolver", |
||||
"remix-astwalker" |
||||
], |
||||
"command": { |
||||
"init": { |
||||
"exact": true |
||||
}, |
||||
"publish": { |
||||
"exact": true, |
||||
"skipGit": true |
||||
} |
||||
}, |
||||
"version": "independent" |
||||
} |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,27 @@ |
||||
{ |
||||
"version": "0.2.3", |
||||
"devDependencies": { |
||||
"gulp": "^4.0.2", |
||||
"lerna": "^2.10.2" |
||||
}, |
||||
"scripts": { |
||||
"diff": "lerna diff", |
||||
"updated": "lerna updated", |
||||
"bootstrap": "lerna bootstrap; npm run build-ts-packages", |
||||
"build-ts-packages": "lerna run --scope 'remix-analyzer' --scope 'remix-astwalker' --scope 'remix-solidity' --scope 'remix-tests' --scope 'remix-url-resolver' build", |
||||
"publish": "npm run build-ts-packages; lerna publish", |
||||
"release": "lerna bootstrap; lerna publish;", |
||||
"tag": "gulp; gulp publishTag;", |
||||
"updateChangelog": "gulp; gulp updateChangelog --prev $previousVersion;", |
||||
"remove-all-install": "npm run remove-install; npm run remove-install-analyzer; npm run remove-install-astwalker; npm run remove-install-debug; npm run remove-install-lib; npm run remove-install-simulator; npm run remove-install-tests; npm run remove-install-url-resolver; npm run remove-install-solidity;", |
||||
"remove-install": "rm package-lock.json; rm -rf node_modules", |
||||
"remove-install-analyzer": "rm remix-analyzer/package-lock.json; rm -rf remix-analyzer/node_modules; rm -rf remix-analyzer/dist", |
||||
"remove-install-astwalker": "rm remix-astwalker/package-lock.json; rm -rf remix-astwalker/node_modules; rm -rf remix-astwalker/dist", |
||||
"remove-install-debug": "rm remix-debug/package-lock.json; rm -rf remix-debug/node_modules", |
||||
"remove-install-lib": "rm remix-lib/package-lock.json; rm -rf remix-lib/node_modules", |
||||
"remove-install-simulator": "rm remix-simulator/package-lock.json; rm -rf remix-simulator/node_modules", |
||||
"remove-install-solidity": "rm remix-solidity/package-lock.json; rm -rf remix-solidity/node_modules; rm -rf remix-solidity/dist", |
||||
"remove-install-tests": "rm remix-tests/package-lock.json; rm -rf remix-tests/node_modules; rm -rf remix-tests/dist", |
||||
"remove-install-url-resolver": "rm remix-url-resolver/package-lock.json; rm -rf remix-url-resolver/node_modules; rm -rf remix-url-resolver/dist" |
||||
} |
||||
} |
||||
@ -0,0 +1,26 @@ |
||||
# Release process |
||||
This document details steps for publishing packages and tag the code base accordingly: |
||||
|
||||
|
||||
1) Publish (using lerna) all the modules that depends on one of the newly published module |
||||
|
||||
- checkout a new branch from master |
||||
- npm run publish (that command use lerna) |
||||
- commit |
||||
|
||||
2) Increment the root (repository scoped) package.json |
||||
|
||||
- increment root package.json version |
||||
- commit |
||||
- merge the branch |
||||
|
||||
3) Create a tag (using the package.json version) |
||||
|
||||
- checkout latest origin/master |
||||
- npm run tag |
||||
- previousVersion=[previous_version] npm run updateChangelog |
||||
- create a new release out of the changes of CHANGELOG.md |
||||
|
||||
4) Commit new updated CHANGELOG.md |
||||
|
||||
|
||||
@ -0,0 +1 @@ |
||||
test/ |
||||
@ -0,0 +1,61 @@ |
||||
## Remix Analyzer |
||||
[](https://www.npmjs.com/package/remix-analyzer) |
||||
[](https://www.npmjs.com/package/remix-analyzer) |
||||
[](https://www.npmjs.com/package/remix-analyzer) |
||||
[](https://github.com/ethereum/remix/tree/master/remix-analyzer) |
||||
[](https://github.com/ethereum/remix/issues) |
||||
|
||||
`remix-analyzer` is a tool to perform static analysis on Solidity smart contracts to check security vulnerabilities and bad development practices. It works underneath Remix IDE plugin "SOLIDITY STATIC ANALYSIS" which is used to run analysis for a compiled contract according to selected modules. |
||||
|
||||
### Installation |
||||
`remix-analyzer` is an NPM package and can be installed using NPM as: |
||||
|
||||
`npm install remix-analyzer` |
||||
|
||||
### How to use |
||||
|
||||
`remix-analyzer` exports below interface: |
||||
|
||||
``` |
||||
import { CompilationResult, AnalyzerModule, AnalysisReport } from 'types'; |
||||
declare type ModuleObj = { |
||||
name: string; |
||||
mod: AnalyzerModule; |
||||
}; |
||||
export default class staticAnalysisRunner { |
||||
/** |
||||
* Run analysis (Used by IDE) |
||||
* @param compilationResult contract compilation result |
||||
* @param toRun module indexes (compiled from remix IDE) |
||||
* @param callback callback |
||||
*/ |
||||
run(compilationResult: CompilationResult, toRun: number[], callback: ((reports: AnalysisReport[]) => void)): void; |
||||
|
||||
/** |
||||
* Run analysis passing list of modules to run |
||||
* @param compilationResult contract compilation result |
||||
* @param modules analysis module |
||||
* @param callback callback |
||||
*/ |
||||
runWithModuleList(compilationResult: CompilationResult, modules: ModuleObj[], callback: ((reports: AnalysisReport[]) => void)): void; |
||||
|
||||
/** |
||||
* Get list of all analysis modules |
||||
*/ |
||||
modules(): any[]; |
||||
} |
||||
``` |
||||
One can import the module and use the available methods to run analysis. Related type descriptions can be seen [here](https://github.com/ethereum/remix/blob/master/remix-analyzer/src/types.ts). |
||||
|
||||
Details of modules are explained in [official remix-ide documentation](https://remix-ide.readthedocs.io/en/latest/static_analysis.html). |
||||
|
||||
### Contribute |
||||
|
||||
We are always open to new features or bug reports. Please feel free to open an issue or a pull request. |
||||
|
||||
In case you want to add some code, do have a look to our contribution guidelnes [here](https://github.com/ethereum/remix/blob/master/CONTRIBUTING.md). Reach us in [Gitter](https://gitter.im/ethereum/remix) in case of any queries. |
||||
|
||||
### License |
||||
|
||||
MIT © 2018-20 Remix Team |
||||
|
||||
@ -0,0 +1 @@ |
||||
export { default as CodeAnalysis} from './src/solidity-analyzer' |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,51 @@ |
||||
{ |
||||
"name": "remix-analyzer", |
||||
"version": "0.5.3", |
||||
"description": "Tool to perform static analysis on Solidity smart contracts", |
||||
"main": "./dist/index.js", |
||||
"types": "./dist/index.d.ts", |
||||
"contributors": [ |
||||
{ |
||||
"name": "Alex Beregszaszi", |
||||
"email": "alex@rtfs.hu" |
||||
}, |
||||
{ |
||||
"name": "Iuri Matias", |
||||
"email": "iuri@ethereum.org" |
||||
}, |
||||
{ |
||||
"name": "Yann Levreau", |
||||
"email": "yann@ethdev.com" |
||||
} |
||||
], |
||||
"dependencies": { |
||||
"remix-astwalker": "0.0.25", |
||||
"remix-lib": "0.4.30" |
||||
}, |
||||
"scripts": { |
||||
"build": "tsc", |
||||
"lint": "standard", |
||||
"test": "tsc && npm run lint && ts-node node_modules/tape/bin/tape ./test/tests.ts" |
||||
}, |
||||
"standard": { |
||||
"ignore": [ |
||||
"node_modules/*", |
||||
"dist/" |
||||
], |
||||
"parser": "babel-eslint" |
||||
}, |
||||
"author": "Remix Team", |
||||
"license": "MIT", |
||||
"homepage": "https://github.com/ethereum/remix/tree/master/remix-analyzer#readme", |
||||
"devDependencies": { |
||||
"@types/node": "^13.7.0", |
||||
"babel-eslint": "^7.1.1", |
||||
"babel-plugin-transform-object-assign": "^6.22.0", |
||||
"babel-preset-es2015": "^6.24.0", |
||||
"npm-install-version": "^6.0.2", |
||||
"standard": "^7.0.1", |
||||
"tape": "^4.6.0", |
||||
"ts-node": "^8.6.2", |
||||
"typescript": "^3.7.5" |
||||
} |
||||
} |
||||
@ -0,0 +1,77 @@ |
||||
'use strict' |
||||
import { AstWalker } from 'remix-astwalker' |
||||
import list from './modules/list' |
||||
import { CompilationResult, AnalyzerModule, AnalysisReportObj, AnalysisReport } from 'types' |
||||
|
||||
type ModuleObj = { |
||||
name: string |
||||
mod: AnalyzerModule |
||||
} |
||||
|
||||
export default class staticAnalysisRunner { |
||||
|
||||
/** |
||||
* Run analysis (Used by IDE) |
||||
* @param compilationResult contract compilation result |
||||
* @param toRun module indexes (compiled from remix IDE) |
||||
* @param callback callback |
||||
*/ |
||||
run (compilationResult: CompilationResult, toRun: number[], callback: ((reports: AnalysisReport[]) => void)): void { |
||||
const modules: ModuleObj[] = toRun.map((i) => { |
||||
const module = this.modules()[i] |
||||
const m = new module() |
||||
return { 'name': m.name, 'mod': m } |
||||
}) |
||||
this.runWithModuleList(compilationResult, modules, callback) |
||||
} |
||||
|
||||
/** |
||||
* Run analysis passing list of modules to run |
||||
* @param compilationResult contract compilation result |
||||
* @param modules analysis module |
||||
* @param callback callback |
||||
*/ |
||||
runWithModuleList (compilationResult: CompilationResult, modules: ModuleObj[], callback: ((reports: AnalysisReport[]) => void)): void { |
||||
let reports: AnalysisReport[] = [] |
||||
// Also provide convenience analysis via the AST walker.
|
||||
const walker = new AstWalker() |
||||
for (let k in compilationResult.sources) { |
||||
walker.walkFull(compilationResult.sources[k].ast,
|
||||
(node: any) => { |
||||
modules.map((item: ModuleObj) => { |
||||
if (item.mod.visit !== undefined) { |
||||
try { |
||||
item.mod.visit(node) |
||||
} catch (e) { |
||||
reports.push({ |
||||
name: item.name, report: [{ warning: 'INTERNAL ERROR in module ' + item.name + ' ' + e.message, error: e.stack }] |
||||
}) |
||||
} |
||||
} |
||||
}) |
||||
return true |
||||
} |
||||
) |
||||
} |
||||
|
||||
// Here, modules can just collect the results from the AST walk,
|
||||
// but also perform new analysis.
|
||||
reports = reports.concat(modules.map((item: ModuleObj) => { |
||||
let report: AnalysisReportObj[] | null = null |
||||
try { |
||||
report = item.mod.report(compilationResult) |
||||
} catch (e) { |
||||
report = [{ warning: 'INTERNAL ERROR in module ' + item.name + ' ' + e.message, error: e.stack }] |
||||
} |
||||
return { name: item.name, report: report } |
||||
})) |
||||
callback(reports) |
||||
} |
||||
|
||||
/** |
||||
* Get list of all analysis modules
|
||||
*/ |
||||
modules (): any[] { |
||||
return list |
||||
} |
||||
} |
||||
@ -0,0 +1,182 @@ |
||||
import { getStateVariableDeclarationsFromContractNode, getInheritsFromName, getContractName, |
||||
getFunctionOrModifierDefinitionParameterPart, getType, getDeclaredVariableName, getFunctionDefinitionReturnParameterPart, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { AstWalker } from 'remix-astwalker' |
||||
import { FunctionDefinitionAstNode, ParameterListAstNode, ModifierDefinitionAstNode, ContractHLAst, VariableDeclarationAstNode,
|
||||
FunctionHLAst, ReportObj, ReportFunction, VisitFunction, ModifierHLAst, CompilationResult } from 'types' |
||||
|
||||
type WrapFunction = ((contracts: ContractHLAst[], isSameName: boolean, version: string) => ReportObj[]) |
||||
|
||||
export default class abstractAstView { |
||||
contracts: ContractHLAst[] = [] |
||||
currentContractIndex: number = -1 |
||||
currentFunctionIndex: number = -1 |
||||
currentModifierIndex: number = -1 |
||||
isFunctionNotModifier: boolean = false |
||||
/* |
||||
file1: contract c{} |
||||
file2: import "file1" as x; contract c{} |
||||
therefore we have two contracts with the same name c. At the moment this is not handled because alias name "x" is not |
||||
available in the current AST implementation thus can not be resolved. |
||||
Additionally the fullQuallified function names e.g. [contractName].[functionName](param1Type, param2Type, ... ) must be prefixed to |
||||
fully support this and when inheritance is resolved it must include alias resolving e.g x.c = file1.c |
||||
*/ |
||||
multipleContractsWithSameName: boolean = false |
||||
|
||||
/** |
||||
* Builds a higher level AST view. I creates a list with each contract as an object in it. |
||||
* Example contractsOut: |
||||
* |
||||
* { |
||||
* "node": {}, // actual AST Node of the contract
|
||||
* "functions": [ |
||||
* { |
||||
* "node": {}, // actual AST Node of the function
|
||||
* "relevantNodes": [], // AST nodes in the function that are relevant for the anlysis of this function
|
||||
* "modifierInvocations": [], // Modifier invocation AST nodes that are applied on this function
|
||||
* "localVariables": [], // Local variable declaration nodes
|
||||
* "parameters": [] // Parameter types of the function in order of definition
|
||||
* "returns": [] // list of return vars as { type: ... , name: ... }
|
||||
* } |
||||
* ], |
||||
* "modifiers": [], // Modifiers definded by the contract, format similar to functions
|
||||
* "inheritsFrom": [], // Names of contract this one inherits from in order of definition
|
||||
* "stateVariables": [] // AST nodes of all State variables
|
||||
* } |
||||
* |
||||
* @relevantNodeFilter {ASTNode -> bool} function that selects relevant ast nodes for analysis on function level. |
||||
* @contractsOut {list} return list for high level AST view |
||||
* @return {ASTNode -> void} returns a function that can be used as visit function for static analysis modules, to build up a higher level AST view for further analysis. |
||||
*/ |
||||
build_visit (relevantNodeFilter: ((node:any) => boolean)): VisitFunction { |
||||
return (node: any) => { |
||||
if (node.nodeType === "ContractDefinition") { |
||||
this.setCurrentContract({ |
||||
node: node, |
||||
functions: [], |
||||
relevantNodes: [], |
||||
modifiers: [], |
||||
inheritsFrom: [], |
||||
stateVariables: getStateVariableDeclarationsFromContractNode(node) |
||||
}) |
||||
} else if (node.nodeType === "InheritanceSpecifier") { |
||||
const currentContract: ContractHLAst = this.getCurrentContract() |
||||
const inheritsFromName: string = getInheritsFromName(node) |
||||
currentContract.inheritsFrom.push(inheritsFromName) |
||||
} else if (node.nodeType === "FunctionDefinition") { |
||||
this.setCurrentFunction({ |
||||
node: node, |
||||
relevantNodes: [], |
||||
modifierInvocations: [], |
||||
localVariables: this.getLocalVariables(node), |
||||
parameters: this.getLocalParameters(node), |
||||
returns: this.getReturnParameters(node) |
||||
}) |
||||
// push back relevant nodes to their the current fn if any
|
||||
this.getCurrentContract().relevantNodes.map((item) => { |
||||
if (item.referencedDeclaration === node.id) { |
||||
this.getCurrentFunction().relevantNodes.push(item.node) |
||||
} |
||||
}) |
||||
} else if (node.nodeType === "ModifierDefinition") { |
||||
this.setCurrentModifier({ |
||||
node: node, |
||||
relevantNodes: [], |
||||
localVariables: this.getLocalVariables(node), |
||||
parameters: this.getLocalParameters(node) |
||||
}) |
||||
} else if (node.nodeType === "ModifierInvocation") { |
||||
if (!this.isFunctionNotModifier) throw new Error('abstractAstView.js: Found modifier invocation outside of function scope.') |
||||
this.getCurrentFunction().modifierInvocations.push(node) |
||||
} else if (relevantNodeFilter(node)) { |
||||
let scope: FunctionHLAst | ModifierHLAst | ContractHLAst = (this.isFunctionNotModifier) ? this.getCurrentFunction() : this.getCurrentModifier() |
||||
if (scope) { |
||||
scope.relevantNodes.push(node) |
||||
} else { |
||||
scope = this.getCurrentContract() // if we are not in a function scope, add the node to the contract scope
|
||||
if (scope && node.referencedDeclaration) { |
||||
scope.relevantNodes.push({ referencedDeclaration: node.referencedDeclaration, node: node }) |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
build_report (wrap: WrapFunction): ReportFunction { |
||||
return (compilationResult: CompilationResult) => { |
||||
const solVersion = getCompilerVersion(compilationResult.contracts) |
||||
this.resolveStateVariablesInHierarchy(this.contracts) |
||||
return wrap(this.contracts, this.multipleContractsWithSameName, solVersion) |
||||
} |
||||
} |
||||
|
||||
private resolveStateVariablesInHierarchy (contracts: ContractHLAst[]): void { |
||||
contracts.map((c: ContractHLAst) => { |
||||
this.resolveStateVariablesInHierarchyForContract(c, contracts) |
||||
}) |
||||
} |
||||
|
||||
private resolveStateVariablesInHierarchyForContract (currentContract: ContractHLAst, contracts: ContractHLAst[]): void { |
||||
currentContract.inheritsFrom.map((inheritsFromName: string) => { |
||||
// add variables from inherited contracts
|
||||
const inheritsFrom: ContractHLAst | undefined = contracts.find((contract: ContractHLAst) => getContractName(contract.node) === inheritsFromName) |
||||
if (inheritsFrom) { |
||||
currentContract.stateVariables = currentContract.stateVariables.concat(inheritsFrom.stateVariables) |
||||
} else { |
||||
console.log('abstractAstView.js: could not find contract defintion inherited from ' + inheritsFromName) |
||||
} |
||||
}) |
||||
} |
||||
|
||||
private setCurrentContract (contract: ContractHLAst): void { |
||||
const name: string = getContractName(contract.node) |
||||
if (this.contracts.map((c: ContractHLAst) => getContractName(c.node)).filter((n) => n === name).length > 0) { |
||||
console.log('abstractAstView.js: two or more contracts with the same name dectected, import aliases not supported at the moment') |
||||
this.multipleContractsWithSameName = true |
||||
} |
||||
this.currentContractIndex = (this.contracts.push(contract) - 1) |
||||
} |
||||
|
||||
private setCurrentFunction (func: FunctionHLAst): void { |
||||
this.isFunctionNotModifier = true |
||||
this.currentFunctionIndex = (this.getCurrentContract().functions.push(func) - 1) |
||||
} |
||||
|
||||
private setCurrentModifier (modi): void { |
||||
this.isFunctionNotModifier = false |
||||
this.currentModifierIndex = (this.getCurrentContract().modifiers.push(modi) - 1) |
||||
} |
||||
|
||||
private getCurrentContract (): ContractHLAst { |
||||
return this.contracts[this.currentContractIndex] |
||||
} |
||||
|
||||
private getCurrentFunction (): FunctionHLAst { |
||||
return this.getCurrentContract().functions[this.currentFunctionIndex] |
||||
} |
||||
|
||||
private getCurrentModifier (): ModifierHLAst { |
||||
return this.getCurrentContract().modifiers[this.currentModifierIndex] |
||||
} |
||||
|
||||
private getLocalParameters (funcNode: FunctionDefinitionAstNode | ModifierDefinitionAstNode): string[] { |
||||
return getFunctionOrModifierDefinitionParameterPart(funcNode).parameters.map(getType) |
||||
} |
||||
|
||||
private getReturnParameters (funcNode: FunctionDefinitionAstNode): Record<string, string>[] { |
||||
return this.getLocalVariables(getFunctionDefinitionReturnParameterPart(funcNode)).map((n: VariableDeclarationAstNode) => { |
||||
return { |
||||
type: getType(n), |
||||
name: getDeclaredVariableName(n) |
||||
} |
||||
}) |
||||
} |
||||
|
||||
private getLocalVariables (funcNode: ParameterListAstNode): VariableDeclarationAstNode[] { |
||||
const locals: VariableDeclarationAstNode[] = [] |
||||
new AstWalker().walkFull(funcNode, (node: any) => { |
||||
if (node.nodeType === "VariableDeclaration") locals.push(node) |
||||
return true |
||||
}) |
||||
return locals |
||||
} |
||||
} |
||||
@ -0,0 +1,9 @@ |
||||
/** |
||||
* Should be used to categorize different modules, main reason is to give users feedback if the modules
|
||||
* Produce exact results or have false positives and negatives in them |
||||
* A further category could be approximate if some form of approximation is used |
||||
*/ |
||||
export default { |
||||
EXACT: { hasFalsePositives: false, hasFalseNegatives: false, id: 'EXACT' }, |
||||
HEURISTIC: { hasFalsePositives: true, hasFalseNegatives: true, id: 'HEURI' } |
||||
} |
||||
@ -0,0 +1,29 @@ |
||||
import { default as category } from './categories' |
||||
import { isSubScopeWithTopLevelUnAssignedBinOp, getUnAssignedTopLevelBinOps } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, BlockAstNode, IfStatementAstNode,
|
||||
WhileStatementAstNode, ForStatementAstNode, CompilationResult, ExpressionStatementAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class assignAndCompare implements AnalyzerModule { |
||||
warningNodes: ExpressionStatementAstNode[] = [] |
||||
name: string = `Result not used: ` |
||||
description: string = `The result of an operation not used` |
||||
category: ModuleCategory = category.MISC |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: BlockAstNode | IfStatementAstNode | WhileStatementAstNode | ForStatementAstNode): void { |
||||
if (node?.nodeType && isSubScopeWithTopLevelUnAssignedBinOp(node)) getUnAssignedTopLevelBinOps(node).forEach((n) => this.warningNodes.push(n)) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
return this.warningNodes.map((item, i) => { |
||||
return { |
||||
warning: 'A binary operation yields a value that is not used further. This is often caused by confusing assignment (=) and comparison (==).', |
||||
location: item.src |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
import { default as category } from './categories' |
||||
import { isBlockBlockHashAccess } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, FunctionCallAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class blockBlockhash implements AnalyzerModule { |
||||
warningNodes: FunctionCallAstNode[] = [] |
||||
name: string = `Block hash: ` |
||||
description: string = `Can be influenced by miners` |
||||
category: ModuleCategory = category.SECURITY |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: FunctionCallAstNode): void { |
||||
if (node.nodeType === 'FunctionCall' && isBlockBlockHashAccess(node)) this.warningNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
return this.warningNodes.map((item, i) => { |
||||
return { |
||||
warning: `Use of "blockhash": "blockhash(uint blockNumber)" is used to access the last 256 block hashes.
|
||||
A miner computes the block hash by "summing up" the information in the current block mined.
|
||||
By "summing up" the information cleverly, a miner can try to influence the outcome of a transaction in the current block.
|
||||
This is especially easy if there are only a small number of equally likely outcomes.`,
|
||||
location: item.src |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
|
||||
@ -0,0 +1,41 @@ |
||||
import { default as category } from './categories' |
||||
import { isNowAccess, isBlockTimestampAccess, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, IdentifierAstNode,
|
||||
MemberAccessAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class blockTimestamp implements AnalyzerModule { |
||||
warningNowNodes: IdentifierAstNode[] = [] |
||||
warningblockTimestampNodes: MemberAccessAstNode[] = [] |
||||
name: string = `Block timestamp: ` |
||||
description: string = `Can be influenced by miners` |
||||
category: ModuleCategory = category.SECURITY |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: IdentifierAstNode | MemberAccessAstNode ): void { |
||||
if (node.nodeType === "Identifier" && isNowAccess(node)) this.warningNowNodes.push(node) |
||||
else if (node.nodeType === "MemberAccess" && isBlockTimestampAccess(node)) this.warningblockTimestampNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.warningNowNodes.map((item, i) => { |
||||
return { |
||||
warning: `Use of "now": "now" does not mean current time. "now" is an alias for "block.timestamp".
|
||||
"block.timestamp" can be influenced by miners to a certain degree, be careful.`,
|
||||
location: item.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/units-and-global-variables.html?highlight=block.timestamp#block-and-transaction-properties` |
||||
} |
||||
}).concat(this.warningblockTimestampNodes.map((item, i) => { |
||||
return { |
||||
warning: `Use of "block.timestamp": "block.timestamp" can be influenced by miners to a certain degree.
|
||||
That means that a miner can "choose" the block.timestamp, to a certain degree, to change the outcome of a transaction in the mined block.`,
|
||||
location: item.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/units-and-global-variables.html?highlight=block.timestamp#block-and-transaction-properties` |
||||
} |
||||
})) |
||||
} |
||||
} |
||||
@ -0,0 +1,6 @@ |
||||
export default { |
||||
SECURITY: {displayName: 'Security', id: 'SEC'}, |
||||
GAS: {displayName: 'Gas & Economy', id: 'GAS'}, |
||||
MISC: {displayName: 'Miscellaneous', id: 'MISC'}, |
||||
ERC: {displayName: 'ERC', id: 'ERC'} |
||||
} |
||||
@ -0,0 +1,95 @@ |
||||
import { default as category } from './categories' |
||||
import { isInteraction, isEffect, isLocalCallGraphRelevantNode, getFullQuallyfiedFuncDefinitionIdent, |
||||
isWriteOnStateVariable, isStorageVariableDeclaration, getFullQualifiedFunctionCallIdent, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { buildGlobalFuncCallGraph, resolveCallGraphSymbol, analyseCallGraph } from './functionCallGraph' |
||||
import AbstractAst from './abstractAstView' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, ContractHLAst, VariableDeclarationAstNode,
|
||||
FunctionHLAst, ContractCallGraph, Context, FunctionCallAstNode, AssignmentAstNode, UnaryOperationAstNode,
|
||||
InlineAssemblyAstNode, ReportFunction, VisitFunction, FunctionCallGraph, SupportedVersion } from './../../types' |
||||
|
||||
export default class checksEffectsInteraction implements AnalyzerModule { |
||||
name: string = `Check-effects-interaction: ` |
||||
description: string = `Potential reentrancy bugs` |
||||
category: ModuleCategory = category.SECURITY |
||||
algorithm: ModuleAlgorithm = algorithm.HEURISTIC |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
abstractAst: AbstractAst = new AbstractAst() |
||||
|
||||
visit: VisitFunction = this.abstractAst.build_visit((node: FunctionCallAstNode | AssignmentAstNode | UnaryOperationAstNode | InlineAssemblyAstNode) => ( |
||||
node.nodeType === 'FunctionCall' && (isInteraction(node) || isLocalCallGraphRelevantNode(node))) ||
|
||||
((node.nodeType === 'Assignment' || node.nodeType === 'UnaryOperation' || node.nodeType === 'InlineAssembly') && isEffect(node))) |
||||
|
||||
report: ReportFunction = this.abstractAst.build_report(this._report.bind(this)) |
||||
|
||||
private _report (contracts: ContractHLAst[], multipleContractsWithSameName: boolean, version: string): ReportObj[] { |
||||
const warnings: ReportObj[] = [] |
||||
const hasModifiers: boolean = contracts.some((item) => item.modifiers.length > 0) |
||||
const callGraph: Record<string, ContractCallGraph> = buildGlobalFuncCallGraph(contracts) |
||||
contracts.forEach((contract) => { |
||||
contract.functions.forEach((func) => { |
||||
func['changesState'] = this.checkIfChangesState( |
||||
getFullQuallyfiedFuncDefinitionIdent( |
||||
contract.node,
|
||||
func.node,
|
||||
func.parameters |
||||
), |
||||
this.getContext( |
||||
callGraph,
|
||||
contract,
|
||||
func) |
||||
) |
||||
}) |
||||
contract.functions.forEach((func: FunctionHLAst) => { |
||||
if (this.isPotentialVulnerableFunction(func, this.getContext(callGraph, contract, func))) { |
||||
const funcName: string = getFullQuallyfiedFuncDefinitionIdent(contract.node, func.node, func.parameters) |
||||
let comments: string = (hasModifiers) ? 'Note: Modifiers are currently not considered by this static analysis.' : '' |
||||
comments += (multipleContractsWithSameName) ? 'Note: Import aliases are currently not supported by this static analysis.' : '' |
||||
warnings.push({ |
||||
warning: `Potential violation of Checks-Effects-Interaction pattern in ${funcName}: Could potentially lead to re-entrancy vulnerability. ${comments}`, |
||||
location: func.node['src'], |
||||
more: `https://solidity.readthedocs.io/en/${version}/security-considerations.html#re-entrancy` |
||||
}) |
||||
} |
||||
}) |
||||
}) |
||||
return warnings |
||||
} |
||||
|
||||
private getContext (callGraph: Record<string, ContractCallGraph>, currentContract: ContractHLAst, func: FunctionHLAst): Context { |
||||
return { callGraph: callGraph, currentContract: currentContract, stateVariables: this.getStateVariables(currentContract, func) } |
||||
} |
||||
|
||||
private getStateVariables (contract: ContractHLAst, func: FunctionHLAst): VariableDeclarationAstNode[] { |
||||
return contract.stateVariables.concat(func.localVariables.filter(isStorageVariableDeclaration)) |
||||
} |
||||
|
||||
private isPotentialVulnerableFunction (func: FunctionHLAst, context: Context): boolean { |
||||
let isPotentialVulnerable: boolean = false |
||||
let interaction: boolean = false |
||||
func.relevantNodes.forEach((node) => { |
||||
if (isInteraction(node)) { |
||||
interaction = true |
||||
} else if (interaction && (isWriteOnStateVariable(node, context.stateVariables) || this.isLocalCallWithStateChange(node, context))) { |
||||
isPotentialVulnerable = true |
||||
} |
||||
}) |
||||
return isPotentialVulnerable |
||||
} |
||||
|
||||
private isLocalCallWithStateChange (node: FunctionCallAstNode, context: Context): boolean { |
||||
if (isLocalCallGraphRelevantNode(node)) { |
||||
const func: FunctionCallGraph | undefined = resolveCallGraphSymbol(context.callGraph, getFullQualifiedFunctionCallIdent(context.currentContract.node, node)) |
||||
return !func || (func && func.node['changesState']) |
||||
} |
||||
return false |
||||
} |
||||
|
||||
private checkIfChangesState (startFuncName: string, context: Context): boolean { |
||||
return analyseCallGraph(context.callGraph, startFuncName, context, (node: any, context: Context) => isWriteOnStateVariable(node, context.stateVariables)) |
||||
} |
||||
} |
||||
|
||||
@ -0,0 +1,117 @@ |
||||
import { default as category } from './categories' |
||||
import { isLowLevelCall, isTransfer, isExternalDirectCall, isEffect, isLocalCallGraphRelevantNode, isSelfdestructCall,
|
||||
isDeleteUnaryOperation, isPayableFunction, isConstructor, getFullQuallyfiedFuncDefinitionIdent, hasFunctionBody,
|
||||
isConstantFunction, isWriteOnStateVariable, isStorageVariableDeclaration, isCallToNonConstLocalFunction,
|
||||
getFullQualifiedFunctionCallIdent} from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { buildGlobalFuncCallGraph, resolveCallGraphSymbol, analyseCallGraph } from './functionCallGraph' |
||||
import AbstractAst from './abstractAstView' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, ContractCallGraph, Context, ContractHLAst,
|
||||
FunctionHLAst, VariableDeclarationAstNode, FunctionCallGraph, FunctionCallAstNode, VisitFunction, ReportFunction, SupportedVersion} from './../../types' |
||||
|
||||
export default class constantFunctions implements AnalyzerModule { |
||||
name: string = `Constant/View/Pure functions: ` |
||||
description: string = `Potentially constant/view/pure functions` |
||||
category: ModuleCategory = category.MISC |
||||
algorithm: ModuleAlgorithm = algorithm.HEURISTIC |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
abstractAst: AbstractAst = new AbstractAst() |
||||
|
||||
visit: VisitFunction = this.abstractAst.build_visit( |
||||
(node: any) => isLowLevelCall(node) || |
||||
isTransfer(node) || |
||||
isExternalDirectCall(node) || |
||||
isEffect(node) || |
||||
isLocalCallGraphRelevantNode(node) || |
||||
node.nodeType === "InlineAssembly" || |
||||
node.nodeType === "NewExpression" || |
||||
isSelfdestructCall(node) || |
||||
isDeleteUnaryOperation(node) |
||||
) |
||||
|
||||
report: ReportFunction = this.abstractAst.build_report(this._report.bind(this)) |
||||
|
||||
private _report (contracts: ContractHLAst[], multipleContractsWithSameName: boolean, version: string): ReportObj[] { |
||||
const warnings: ReportObj[] = [] |
||||
const hasModifiers: boolean = contracts.some((item) => item.modifiers.length > 0) |
||||
|
||||
const callGraph: Record<string, ContractCallGraph> = buildGlobalFuncCallGraph(contracts) |
||||
|
||||
contracts.forEach((contract: ContractHLAst) => { |
||||
contract.functions.forEach((func: FunctionHLAst) => { |
||||
if (isPayableFunction(func.node) || isConstructor(func.node)) { |
||||
func['potentiallyshouldBeConst'] = false |
||||
} else { |
||||
func['potentiallyshouldBeConst'] = this.checkIfShouldBeConstant( |
||||
getFullQuallyfiedFuncDefinitionIdent( |
||||
contract.node,
|
||||
func.node,
|
||||
func.parameters |
||||
), |
||||
this.getContext( |
||||
callGraph,
|
||||
contract,
|
||||
func |
||||
) |
||||
) |
||||
} |
||||
}) |
||||
contract.functions.filter((func: FunctionHLAst) => hasFunctionBody(func.node)).forEach((func: FunctionHLAst) => { |
||||
if (isConstantFunction(func.node) !== func['potentiallyshouldBeConst']) { |
||||
const funcName: string = getFullQuallyfiedFuncDefinitionIdent(contract.node, func.node, func.parameters) |
||||
let comments: string = (hasModifiers) ? 'Note: Modifiers are currently not considered by this static analysis.' : '' |
||||
comments += (multipleContractsWithSameName) ? 'Note: Import aliases are currently not supported by this static analysis.' : '' |
||||
if (func['potentiallyshouldBeConst']) { |
||||
warnings.push({ |
||||
warning: `${funcName} : Potentially should be constant/view/pure but is not. ${comments}`, |
||||
location: func.node['src'], |
||||
more: `https://solidity.readthedocs.io/en/${version}/contracts.html#view-functions` |
||||
}) |
||||
} else { |
||||
warnings.push({ |
||||
warning: `${funcName} : Is constant but potentially should not be. ${comments}`, |
||||
location: func.node['src'], |
||||
more: `https://solidity.readthedocs.io/en/${version}/contracts.html#view-functions` |
||||
}) |
||||
} |
||||
} |
||||
}) |
||||
}) |
||||
return warnings |
||||
} |
||||
|
||||
private getContext (callGraph: Record<string, ContractCallGraph>, currentContract: ContractHLAst, func: FunctionHLAst): Context { |
||||
return { callGraph: callGraph, currentContract: currentContract, stateVariables: this.getStateVariables(currentContract, func) } |
||||
} |
||||
|
||||
private getStateVariables (contract: ContractHLAst, func: FunctionHLAst): VariableDeclarationAstNode[] { |
||||
return contract.stateVariables.concat(func.localVariables.filter(isStorageVariableDeclaration)) |
||||
} |
||||
|
||||
private checkIfShouldBeConstant (startFuncName: string, context: Context): boolean { |
||||
return !analyseCallGraph(context.callGraph, startFuncName, context, this.isConstBreaker.bind(this)) |
||||
} |
||||
|
||||
private isConstBreaker (node: any, context: Context): boolean { |
||||
return isWriteOnStateVariable(node, context.stateVariables) || |
||||
isLowLevelCall(node) || |
||||
isTransfer(node) || |
||||
this.isCallOnNonConstExternalInterfaceFunction(node, context) || |
||||
isCallToNonConstLocalFunction(node) || |
||||
node.nodeType === "InlineAssembly" || |
||||
node.nodeType === "NewExpression" || |
||||
isSelfdestructCall(node) || |
||||
isDeleteUnaryOperation(node) |
||||
} |
||||
|
||||
private isCallOnNonConstExternalInterfaceFunction (node: FunctionCallAstNode, context: Context): boolean { |
||||
if (isExternalDirectCall(node)) { |
||||
const func: FunctionCallGraph | undefined = resolveCallGraphSymbol(context.callGraph, getFullQualifiedFunctionCallIdent(context.currentContract.node, node)) |
||||
return !func || (func && !isConstantFunction(func.node.node)) |
||||
} |
||||
return false |
||||
} |
||||
} |
||||
@ -0,0 +1,30 @@ |
||||
import { default as category } from './categories' |
||||
import { isDeleteOfDynamicArray, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, UnaryOperationAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class deleteDynamicArrays implements AnalyzerModule { |
||||
rel: UnaryOperationAstNode[] = [] |
||||
name: string = `Delete dynamic array: ` |
||||
description: string = `Use require/assert to ensure complete deletion` |
||||
category: ModuleCategory = category.GAS |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: UnaryOperationAstNode): void { |
||||
if (isDeleteOfDynamicArray(node)) this.rel.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.rel.map((node) => { |
||||
return { |
||||
warning: `The "delete" operation when applied to a dynamically sized array in Solidity generates code to delete each of the elements contained. If the array is large, this operation can surpass the block gas limit and raise an OOG exception. Also nested dynamically sized objects can produce the same results.`, |
||||
location: node.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/types.html#delete` |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,29 @@ |
||||
import { default as category } from './categories' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { isDeleteFromDynamicArray, isMappingIndexAccess } from './staticAnalysisCommon' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, UnaryOperationAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class deleteFromDynamicArray implements AnalyzerModule { |
||||
relevantNodes: UnaryOperationAstNode[] = [] |
||||
name: string = `Delete from dynamic array: ` |
||||
description: string = `'delete' leaves a gap in array` |
||||
category: ModuleCategory = category.MISC |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: UnaryOperationAstNode): void { |
||||
if (isDeleteFromDynamicArray(node) && !isMappingIndexAccess(node.subExpression)) this.relevantNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
return this.relevantNodes.map((node) => { |
||||
return { |
||||
warning: `Using "delete" on an array leaves a gap. The length of the array remains the same. If you want to remove the empty position you need to shift items manually and update the "length" property.`, |
||||
location: node.src, |
||||
more: 'https://github.com/miguelmota/solidity-idiosyncrasies#examples' |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,66 @@ |
||||
import { default as category } from './categories' |
||||
import { getFunctionDefinitionName, helpers, getDeclaredVariableName, getDeclaredVariableType } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import AbstractAst from './abstractAstView' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, VisitFunction, ReportFunction, ContractHLAst,
|
||||
FunctionHLAst, VariableDeclarationAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class erc20Decimals implements AnalyzerModule { |
||||
name: string = `ERC20: ` |
||||
description: string = `'decimals' should be 'uint8'` |
||||
category: ModuleCategory = category.ERC |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
abstractAst: AbstractAst = new AbstractAst() |
||||
visit: VisitFunction = this.abstractAst.build_visit((node: any) => false) |
||||
report: ReportFunction = this.abstractAst.build_report(this._report.bind(this)) |
||||
|
||||
private _report (contracts: ContractHLAst[], multipleContractsWithSameName: boolean): ReportObj[] { |
||||
const warnings: ReportObj[] = [] |
||||
|
||||
contracts.forEach((contract: ContractHLAst) => { |
||||
const contractAbiSignatures: string[] = contract.functions.map((f: FunctionHLAst) => helpers.buildAbiSignature(getFunctionDefinitionName(f.node), f.parameters)) |
||||
|
||||
if (this.isERC20(contractAbiSignatures)) { |
||||
const decimalsVar: VariableDeclarationAstNode[] = contract.stateVariables.filter((stateVar: VariableDeclarationAstNode) => getDeclaredVariableName(stateVar) === 'decimals' && (getDeclaredVariableType(stateVar) !== 'uint8' || stateVar.visibility !== 'public')) |
||||
const decimalsFun: FunctionHLAst[] = contract.functions.filter((f: FunctionHLAst) => getFunctionDefinitionName(f.node) === 'decimals' && |
||||
( |
||||
(f.returns.length === 0 || f.returns.length > 1) || |
||||
(f.returns.length === 1 && (f.returns[0].type !== 'uint8' || f.node.visibility !== 'public')) |
||||
) |
||||
) |
||||
if (decimalsVar.length > 0) { |
||||
for (const node of decimalsVar) { |
||||
warnings.push({ |
||||
warning: `ERC20 contract's "decimals" variable should be "uint8" type`, |
||||
location: node.src, |
||||
more: 'https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md#decimals' |
||||
}) |
||||
} |
||||
} else if (decimalsFun.length > 0) { |
||||
for (const fn of decimalsFun) { |
||||
warnings.push({ |
||||
warning: `ERC20 contract's "decimals" function should have "uint8" as return type`, |
||||
location: fn.node.src, |
||||
more: 'https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md#decimals' |
||||
}) |
||||
} |
||||
} |
||||
} |
||||
}) |
||||
return warnings |
||||
} |
||||
|
||||
private isERC20 (funSignatures: string[]): boolean { |
||||
return funSignatures.includes('totalSupply()') && |
||||
funSignatures.includes('balanceOf(address)') && |
||||
funSignatures.includes('transfer(address,uint256)') && |
||||
funSignatures.includes('transferFrom(address,address,uint256)') && |
||||
funSignatures.includes('approve(address,uint256)') && |
||||
funSignatures.includes('allowance(address,address)') |
||||
} |
||||
} |
||||
|
||||
@ -0,0 +1,42 @@ |
||||
import { default as category } from './categories' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { isLoop, isTransfer, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, ForStatementAstNode,
|
||||
WhileStatementAstNode, ExpressionStatementAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class etherTransferInLoop implements AnalyzerModule { |
||||
relevantNodes: ExpressionStatementAstNode[] = [] |
||||
name: string = `Ether transfer in loop: ` |
||||
description: string = `Transferring Ether in a for/while/do-while loop` |
||||
category: ModuleCategory = category.GAS |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: ForStatementAstNode | WhileStatementAstNode): void { |
||||
let transferNodes: ExpressionStatementAstNode[] = [] |
||||
if(isLoop(node)) { |
||||
if(node.body && node.body.nodeType === 'Block') |
||||
transferNodes = node.body.statements.filter(child => ( child.nodeType === 'ExpressionStatement' && |
||||
child.expression.nodeType === 'FunctionCall' && isTransfer(child.expression.expression))) |
||||
// When loop body is described without braces
|
||||
else if(node.body && node.body.nodeType === 'ExpressionStatement' && node.body.expression.nodeType === 'FunctionCall' && isTransfer(node.body.expression.expression)) |
||||
transferNodes.push(node.body) |
||||
if (transferNodes.length > 0) { |
||||
this.relevantNodes.push(...transferNodes) |
||||
} |
||||
} |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.relevantNodes.map((node) => { |
||||
return { |
||||
warning: `Ether payout should not be done in a loop: Due to the block gas limit, transactions can only consume a certain amount of gas. The number of iterations in a loop can grow beyond the block gas limit which can cause the complete contract to be stalled at a certain point. If required then make sure that number of iterations are low and you trust each address involved.`, |
||||
location: node.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/security-considerations.html#gas-limit-and-loops` |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,36 @@ |
||||
import { default as category } from './categories' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { isDynamicArrayLengthAccess, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, ForStatementAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class forLoopIteratesOverDynamicArray implements AnalyzerModule { |
||||
relevantNodes: ForStatementAstNode[] = [] |
||||
name: string = `For loop over dynamic array: ` |
||||
description: string = `Iterations depend on dynamic array's size` |
||||
category: ModuleCategory = category.GAS |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: ForStatementAstNode): void { |
||||
const { condition } = node |
||||
// Check if condition is `i < array.length - 1`
|
||||
if ((condition && condition.nodeType === "BinaryOperation" && condition.rightExpression.nodeType === "BinaryOperation" && isDynamicArrayLengthAccess(condition.rightExpression.leftExpression)) ||
|
||||
// or condition is `i < array.length`
|
||||
(condition && condition.nodeType === "BinaryOperation" && isDynamicArrayLengthAccess(condition.rightExpression))) { |
||||
this.relevantNodes.push(node) |
||||
} |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.relevantNodes.map((node) => { |
||||
return { |
||||
warning: `Loops that do not have a fixed number of iterations, for example, loops that depend on storage values, have to be used carefully. Due to the block gas limit, transactions can only consume a certain amount of gas. The number of iterations in a loop can grow beyond the block gas limit which can cause the complete contract to be stalled at a certain point. \n Additionally, using unbounded loops incurs in a lot of avoidable gas costs. Carefully test how many items at maximum you can pass to such functions to make it successful.`, |
||||
location: node.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/security-considerations.html#gas-limit-and-loops` |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,113 @@ |
||||
'use strict' |
||||
|
||||
import { FunctionHLAst, ContractHLAst, FunctionCallGraph, ContractCallGraph, Context, FunctionCallAstNode } from "types" |
||||
import { isLocalCallGraphRelevantNode, isExternalDirectCall, getFullQualifiedFunctionCallIdent,
|
||||
getFullQuallyfiedFuncDefinitionIdent, getContractName } from './staticAnalysisCommon' |
||||
|
||||
type filterNodesFunction = (node: FunctionCallAstNode) => boolean |
||||
type NodeIdentFunction = (node: FunctionCallAstNode) => string |
||||
type FunDefIdentFunction = (node: FunctionHLAst) => string |
||||
|
||||
function buildLocalFuncCallGraphInternal (functions: FunctionHLAst[], nodeFilter: filterNodesFunction , extractNodeIdent: NodeIdentFunction, extractFuncDefIdent: FunDefIdentFunction): Record<string, FunctionCallGraph> { |
||||
const callGraph: Record<string, FunctionCallGraph> = {} |
||||
functions.forEach((func: FunctionHLAst) => { |
||||
const calls: string[] = func.relevantNodes |
||||
.filter(nodeFilter) |
||||
.map(extractNodeIdent) |
||||
.filter((name: string) => name !== extractFuncDefIdent(func)) // filter self recursive call
|
||||
|
||||
callGraph[extractFuncDefIdent(func)] = { node: func, calls: calls } |
||||
}) |
||||
return callGraph |
||||
} |
||||
|
||||
/** |
||||
* Builds a function call graph for the current contracts. |
||||
* Example Contract call graph: |
||||
* |
||||
* { |
||||
* "KingOfTheEtherThrone": { |
||||
* "contracts": {...}, // Contract node as defined in abstractAstView.js
|
||||
* "functions": { |
||||
* "KingOfTheEtherThrone.claimThrone(string memory)": { // function in KingOfEtherThrone
|
||||
* "node": {...}, // function node as defined in abstractAstView.js
|
||||
* "calls": { // list of full qualified function names which are called form this function
|
||||
* } |
||||
* } |
||||
* } |
||||
* }, |
||||
* "foo": { |
||||
* "contract": {...}, // Contract node as definded in abstractAstView.js
|
||||
* "functions": {} // map from full qualified function name to func node
|
||||
* } |
||||
* } |
||||
* |
||||
* @contracts {list contracts} Expects as input the contract structure defined in abstractAstView.js |
||||
* @return {map (string -> Contract Call Graph)} returns map from contract name to contract call graph |
||||
*/ |
||||
export function buildGlobalFuncCallGraph (contracts: ContractHLAst[]): Record<string, ContractCallGraph> { |
||||
const callGraph: Record<string, ContractCallGraph> = {} |
||||
contracts.forEach((contract: ContractHLAst) => { |
||||
const filterNodes: filterNodesFunction = (node: FunctionCallAstNode) => { return isLocalCallGraphRelevantNode(node) || isExternalDirectCall(node) } |
||||
const getNodeIdent: NodeIdentFunction = (node: FunctionCallAstNode) => { return getFullQualifiedFunctionCallIdent(contract.node, node) } |
||||
const getFunDefIdent: FunDefIdentFunction = (funcDef: FunctionHLAst) => { return getFullQuallyfiedFuncDefinitionIdent(contract.node, funcDef.node, funcDef.parameters) } |
||||
|
||||
callGraph[getContractName(contract.node)] = { contract: contract, functions: buildLocalFuncCallGraphInternal(contract.functions, filterNodes, getNodeIdent, getFunDefIdent) } |
||||
}) |
||||
return callGraph |
||||
} |
||||
|
||||
/** |
||||
* Walks through the call graph from a defined starting function, true if nodeCheck holds for every relevant node in the callgraph |
||||
* @callGraph {callGraph} As returned by buildGlobalFuncCallGraph |
||||
* @funcName {string} full qualified name of the starting function |
||||
* @context {Object} provides additional context information that can be used by the nodeCheck function |
||||
* @nodeCheck {(ASTNode, context) -> bool} applied on every relevant node in the call graph |
||||
* @return {bool} returns map from contract name to contract call graph |
||||
*/ |
||||
export function analyseCallGraph (callGraph: Record<string, ContractCallGraph>, funcName: string, context: Context, nodeCheck: ((node: any, context: Context) => boolean)): boolean { |
||||
return analyseCallGraphInternal(callGraph, funcName, context, (a, b) => a || b, nodeCheck, {}) |
||||
} |
||||
|
||||
function analyseCallGraphInternal (callGraph: Record<string, ContractCallGraph>, funcName: string, context: Context, combinator: Function, nodeCheck: ((node: any, context: Context) => boolean), visited : Record<string, boolean>): boolean { |
||||
const current: FunctionCallGraph | undefined = resolveCallGraphSymbol(callGraph, funcName) |
||||
|
||||
if (current === undefined || visited[funcName] === true) return true |
||||
visited[funcName] = true |
||||
|
||||
return combinator(current.node.relevantNodes.reduce((acc, val) => combinator(acc, nodeCheck(val, context)), false), |
||||
current.calls.reduce((acc, val) => combinator(acc, analyseCallGraphInternal(callGraph, val, context, combinator, nodeCheck, visited)), false)) |
||||
} |
||||
|
||||
export function resolveCallGraphSymbol (callGraph: Record<string, ContractCallGraph>, funcName: string): FunctionCallGraph | undefined { |
||||
return resolveCallGraphSymbolInternal(callGraph, funcName, false) |
||||
} |
||||
|
||||
function resolveCallGraphSymbolInternal (callGraph: Record<string, ContractCallGraph>, funcName: string, silent: boolean): FunctionCallGraph | undefined { |
||||
let current: FunctionCallGraph | null = null |
||||
if (funcName.includes('.')) { |
||||
const parts: string[] = funcName.split('.') |
||||
const contractPart: string = parts[0] |
||||
const functionPart: string = parts[1] |
||||
const currentContract: ContractCallGraph = callGraph[contractPart] |
||||
if (!(currentContract === undefined)) { |
||||
current = currentContract.functions[funcName] |
||||
// resolve inheritance hierarchy
|
||||
if (current === undefined) { |
||||
// resolve inheritance lookup in linearized fashion
|
||||
const inheritsFromNames: string[] = currentContract.contract.inheritsFrom.reverse() |
||||
for (let i = 0; i < inheritsFromNames.length; i++) { |
||||
const res: FunctionCallGraph | undefined = resolveCallGraphSymbolInternal(callGraph, inheritsFromNames[i] + '.' + functionPart, true) |
||||
if (!(res === undefined)) return res |
||||
} |
||||
} |
||||
} else { |
||||
if (!silent) console.log(`static analysis functionCallGraph.js: Contract ${contractPart} not found in function call graph.`) |
||||
} |
||||
} else { |
||||
throw new Error('functionCallGraph.js: function does not have full qualified name.') |
||||
} |
||||
if (current === undefined && !silent) console.log(`static analysis functionCallGraph.js: ${funcName} not found in function call graph.`) |
||||
if(current !== null) |
||||
return current |
||||
} |
||||
@ -0,0 +1,92 @@ |
||||
import { default as category } from './categories' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { getFunctionDefinitionName, helpers, isVariableTurnedIntoGetter, getMethodParamsSplittedTypeDesc } from './staticAnalysisCommon' |
||||
import { ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, CompiledContract, AnalyzerModule,
|
||||
FunctionDefinitionAstNode, VariableDeclarationAstNode, SupportedVersion } from './../../types' |
||||
|
||||
export default class gasCosts implements AnalyzerModule { |
||||
name: string = `Gas costs: ` |
||||
description: string = `Too high gas requirement of functions` |
||||
category: ModuleCategory = category.GAS |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
warningNodes: any[] = [] |
||||
visit (node: FunctionDefinitionAstNode | VariableDeclarationAstNode): void { |
||||
if ((node.nodeType === 'FunctionDefinition' && node.kind !== 'constructor' && node.implemented) ||
|
||||
(node.nodeType === 'VariableDeclaration' && isVariableTurnedIntoGetter(node)))
|
||||
this.warningNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const report: ReportObj[] = [] |
||||
const methodsWithSignature: Record<string, string>[] = this.warningNodes.map(node => { |
||||
let signature: string; |
||||
if(node.nodeType === 'FunctionDefinition'){ |
||||
const functionName: string = getFunctionDefinitionName(node) |
||||
signature = helpers.buildAbiSignature(functionName, getMethodParamsSplittedTypeDesc(node, compilationResults.contracts)) |
||||
} |
||||
else
|
||||
signature = node.name + '()' |
||||
|
||||
return { |
||||
name: node.name, |
||||
src: node.src, |
||||
signature: signature |
||||
} |
||||
}) |
||||
for (const method of methodsWithSignature) { |
||||
for (const filename in compilationResults.contracts) { |
||||
for (const contractName in compilationResults.contracts[filename]) { |
||||
const contract: CompiledContract = compilationResults.contracts[filename][contractName] |
||||
const methodGas: Record<string, any> | undefined = this.checkMethodGas(contract, method.signature) |
||||
if(methodGas && methodGas.isInfinite) { |
||||
if(methodGas.isFallback) { |
||||
report.push({ |
||||
warning: `Fallback function of contract ${contractName} requires too much gas (${methodGas.msg}).
|
||||
If the fallback function requires more than 2300 gas, the contract cannot receive Ether.`,
|
||||
location: method.src |
||||
}) |
||||
} else { |
||||
report.push({ |
||||
warning: `Gas requirement of function ${contractName}.${method.name} ${methodGas.msg}:
|
||||
If the gas requirement of a function is higher than the block gas limit, it cannot be executed. |
||||
Please avoid loops in your functions or actions that modify large areas of storage |
||||
(this includes clearing or copying arrays in storage)`,
|
||||
location: method.src |
||||
}) |
||||
}
|
||||
} else continue |
||||
} |
||||
} |
||||
} |
||||
return report |
||||
} |
||||
|
||||
private checkMethodGas(contract: CompiledContract, methodSignature: string): Record<string, any> | undefined { |
||||
if(contract.evm && contract.evm.gasEstimates && contract.evm.gasEstimates.external) { |
||||
if(methodSignature === '()') { |
||||
const fallback: string = contract.evm.gasEstimates.external[''] |
||||
if (fallback !== undefined && (fallback === null || parseInt(fallback) >= 2100 || fallback === 'infinite')) { |
||||
return { |
||||
isInfinite: true, |
||||
isFallback: true, |
||||
msg: fallback |
||||
} |
||||
}
|
||||
} else { |
||||
const gas: string = contract.evm.gasEstimates.external[methodSignature] |
||||
const gasString: string = gas === null ? 'unknown or not constant' : 'is ' + gas |
||||
if (gas === null || parseInt(gas) >= 3000000 || gas === 'infinite') { |
||||
return { |
||||
isInfinite: true, |
||||
isFallback: false, |
||||
msg: gasString |
||||
} |
||||
}
|
||||
} |
||||
} |
||||
}
|
||||
} |
||||
@ -0,0 +1,30 @@ |
||||
import { default as category } from './categories' |
||||
import { isRequireCall, isAssertCall, getCompilerVersion } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, FunctionCallAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class guardConditions implements AnalyzerModule { |
||||
guards: FunctionCallAstNode[] = [] |
||||
name: string = `Guard conditions: ` |
||||
description: string = `Ensure appropriate use of require/assert` |
||||
category: ModuleCategory = category.MISC |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: FunctionCallAstNode): void { |
||||
if (isRequireCall(node) || isAssertCall(node)) this.guards.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.guards.map((node) => { |
||||
return { |
||||
warning: `Use "assert(x)" if you never ever want x to be false, not in any circumstance (apart from a bug in your code). Use "require(x)" if x can be false, due to e.g. invalid input or a failing external component.`, |
||||
location: node.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/control-structures.html#error-handling-assert-require-revert-and-exceptions` |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,21 @@ |
||||
export { default as txOrigin } from './txOrigin' |
||||
export { default as gasCosts } from './gasCosts' |
||||
export { default as thisLocal } from './thisLocal' |
||||
export { default as checksEffectsInteraction } from './checksEffectsInteraction' |
||||
export { default as constantFunctions } from './constantFunctions' |
||||
export { default as similarVariableNames } from './similarVariableNames' |
||||
export { default as inlineAssembly } from './inlineAssembly' |
||||
export { default as blockTimestamp } from './blockTimestamp' |
||||
export { default as lowLevelCalls } from './lowLevelCalls' |
||||
export { default as blockBlockhash } from './blockBlockhash' |
||||
export { default as noReturn } from './noReturn' |
||||
export { default as selfdestruct } from './selfdestruct' |
||||
export { default as guardConditions } from './guardConditions' |
||||
export { default as deleteDynamicArrays } from './deleteDynamicArrays' |
||||
export { default as assignAndCompare } from './assignAndCompare' |
||||
export { default as erc20Decimals } from './erc20Decimals' |
||||
export { default as stringBytesLength } from './stringBytesLength' |
||||
export { default as intDivisionTruncate } from './intDivisionTruncate' |
||||
export { default as etherTransferInLoop } from './etherTransferInLoop' |
||||
export { default as deleteFromDynamicArray } from './deleteFromDynamicArray' |
||||
export { default as forLoopIteratesOverDynamicArray } from './forLoopIteratesOverDynamicArray' |
||||
@ -0,0 +1,31 @@ |
||||
import { default as category } from './categories' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, InlineAssemblyAstNode, SupportedVersion} from './../../types' |
||||
import { getCompilerVersion } from './staticAnalysisCommon' |
||||
|
||||
export default class inlineAssembly implements AnalyzerModule { |
||||
inlineAssNodes: InlineAssemblyAstNode[] = [] |
||||
name: string = `Inline assembly: ` |
||||
description: string = `Inline assembly used` |
||||
category: ModuleCategory = category.SECURITY |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: InlineAssemblyAstNode): void { |
||||
if(node.nodeType === 'InlineAssembly') this.inlineAssNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
const version = getCompilerVersion(compilationResults.contracts) |
||||
return this.inlineAssNodes.map((node) => { |
||||
return { |
||||
warning: `The Contract uses inline assembly, this is only advised in rare cases.
|
||||
Additionally static analysis modules do not parse inline Assembly, this can lead to wrong analysis results.`,
|
||||
location: node.src, |
||||
more: `https://solidity.readthedocs.io/en/${version}/assembly.html` |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
import { default as category } from './categories' |
||||
import { isIntDivision } from './staticAnalysisCommon' |
||||
import { default as algorithm } from './algorithmCategories' |
||||
import { AnalyzerModule, ModuleAlgorithm, ModuleCategory, ReportObj, CompilationResult, BinaryOperationAstNode, SupportedVersion} from './../../types' |
||||
|
||||
export default class intDivisionTruncate implements AnalyzerModule { |
||||
warningNodes: BinaryOperationAstNode[] = [] |
||||
name: string = `Data truncated: ` |
||||
description: string = `Division on int/uint values truncates the result` |
||||
category: ModuleCategory = category.MISC |
||||
algorithm: ModuleAlgorithm = algorithm.EXACT |
||||
version: SupportedVersion = { |
||||
start: '0.4.12' |
||||
} |
||||
|
||||
visit (node: BinaryOperationAstNode): void { |
||||
if (isIntDivision(node)) this.warningNodes.push(node) |
||||
} |
||||
|
||||
report (compilationResults: CompilationResult): ReportObj[] { |
||||
return this.warningNodes.map((item, i) => { |
||||
return { |
||||
warning: 'Division of integer values yields an integer value again. That means e.g. 10 / 100 = 0 instead of 0.1 since the result is an integer again. This does not hold for division of (only) literal values since those yield rational constants.', |
||||
location: item.src |
||||
} |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,45 @@ |
||||
import txOrigin from './txOrigin' |
||||
import gasCosts from './gasCosts' |
||||
import thisLocal from './thisLocal' |
||||
import checksEffectsInteraction from './checksEffectsInteraction' |
||||
import constantFunctions from './constantFunctions' |
||||
import similarVariableNames from './similarVariableNames' |
||||
import inlineAssembly from './inlineAssembly' |
||||
import blockTimestamp from './blockTimestamp' |
||||
import lowLevelCalls from './lowLevelCalls' |
||||
import blockBlockhash from './blockBlockhash' |
||||
import noReturn from './noReturn' |
||||
import selfdestruct from './selfdestruct' |
||||
import guardConditions from './guardConditions' |
||||
import deleteDynamicArrays from './deleteDynamicArrays' |
||||
import assignAndCompare from './assignAndCompare' |
||||
import erc20Decimals from './erc20Decimals' |
||||
import stringBytesLength from './stringBytesLength' |
||||
import deleteFromDynamicArray from './deleteFromDynamicArray' |
||||
import forLoopIteratesOverDynamicArray from './forLoopIteratesOverDynamicArray' |
||||
import etherTransferInLoop from './etherTransferInLoop' |
||||
import intDivisionTruncate from './intDivisionTruncate' |
||||
|
||||
export default [ |
||||
txOrigin, |
||||
gasCosts, |
||||
thisLocal, |
||||
checksEffectsInteraction, |
||||
erc20Decimals, |
||||
constantFunctions, |
||||
similarVariableNames, |
||||
inlineAssembly, |
||||
blockTimestamp, |
||||
lowLevelCalls, |
||||
blockBlockhash, |
||||
noReturn, |
||||
selfdestruct, |
||||
guardConditions, |
||||
deleteDynamicArrays, |
||||
assignAndCompare, |
||||
stringBytesLength, |
||||
deleteFromDynamicArray, |
||||
forLoopIteratesOverDynamicArray, |
||||
etherTransferInLoop, |
||||
intDivisionTruncate |
||||
] |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue