Use local EVM for pure functions #2108

xianny · 2019-08-28T21:55:35Z

Description

Currently, @0x/contract-wrappers provides a convenience method callAsync which does an eth_call for any pure or view functions. The pure functions don't require any blockchain state and can be computed locally. This PR uses ethereumjs-vm to instantiate a local EVM, and uses it for pure functions instead of performing the eth_call. This is an implementation detail and is hidden from end users. The method signature for callAsync is the same in either case.

Affected methods:

9 methods in DevUtils related to encoding and decoding
all getProxyId methods (5)

Resolves #1872

Testing instructions

Pure methods in abi_gen_dummy.ts have been updated as part of this change. All unit tests should still pass.

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

Prefix PR title with [WIP] if necessary.
Add tests to cover changes as needed.
Update documentation as needed.
Add new entries to the relevant CHANGELOG.jsons.

buildsize · 2019-08-28T22:19:42Z

File name	Previous Size	New Size	Change
init.py	7.04 KB	[deleted]
abi_gen_dummy.ts	145.2 KB	[deleted]
lib_dummy.ts	4.84 KB	[deleted]
test_lib_dummy.ts	12.71 KB	[deleted]
environment.pickle	1.56 MB	1.56 MB	0 bytes (0%)
index.doctree	190.98 KB	190.98 KB	0 bytes (0%)
.buildinfo	230 bytes	230 bytes	0 bytes (0%)
genindex.html	5.6 KB	5.6 KB	0 bytes (0%)
index.html	2.52 KB	2.52 KB	0 bytes (0%)
objects.inv	375 bytes	375 bytes	0 bytes (0%)
py-modindex.html	3.07 KB	3.07 KB	0 bytes (0%)
search.html	2.84 KB	2.84 KB	0 bytes (0%)
searchindex.js	5.82 KB	5.82 KB	0 bytes (0%)
index.rst.txt	415 bytes	415 bytes	0 bytes (0%)
alabaster.css	10.92 KB	10.92 KB	0 bytes (0%)
basic.css	11.89 KB	11.89 KB	0 bytes (0%)
custom.css	42 bytes	42 bytes	0 bytes (0%)
doctools.js	9.05 KB	9.05 KB	0 bytes (0%)
documentation_options.js	303 bytes	303 bytes	0 bytes (0%)
file.png	286 bytes	286 bytes	0 bytes (0%)
jquery-[version].js	273.79 KB	273.79 KB	0 bytes (0%)
jquery.js	86.08 KB	86.08 KB	0 bytes (0%)
language_data.js	10.59 KB	10.59 KB	0 bytes (0%)
minus.png	90 bytes	90 bytes	0 bytes (0%)
plus.png	90 bytes	90 bytes	0 bytes (0%)
pygments.css	4.69 KB	4.69 KB	0 bytes (0%)
searchtools.js	15.61 KB	15.61 KB	0 bytes (0%)
underscore-[version].js	34.34 KB	34.34 KB	0 bytes (0%)
underscore.js	11.86 KB	11.86 KB	0 bytes (0%)
contract_addresses.html	17.89 KB	17.89 KB	0 bytes (0%)
contract_artifacts.html	8.24 KB	8.24 KB	0 bytes (0%)
_bootstrap.html	142.73 KB	142.73 KB	0 bytes (0%)
json_schemas.html	12.43 KB	12.43 KB	0 bytes (0%)
order_utils.html	44.83 KB	44.83 KB	0 bytes (0%)
erc20_token.html	88.14 KB	88.14 KB	0 bytes (0%)
exchange.html	506.16 KB	506.16 KB	0 bytes (0%)
tx_params.html	8.83 KB	8.83 KB	0 bytes (0%)
local_message_signer.html	15.07 KB	15.07 KB	0 bytes (0%)
asset_data_utils.html	22.65 KB	22.65 KB	0 bytes (0%)
default_api.html	118.48 KB	118.48 KB	0 bytes (0%)
asset_proxy_owner.html	341.77 KB	341.77 KB	0 bytes (0%)
coordinator.html	127.47 KB	127.47 KB	0 bytes (0%)
coordinator_registry.html	36.15 KB	36.15 KB	0 bytes (0%)
dutch_auction.html	54.84 KB	54.84 KB	0 bytes (0%)
erc20_proxy.html	105.63 KB	105.63 KB	0 bytes (0%)
erc721_proxy.html	105.72 KB	105.72 KB	0 bytes (0%)
erc721_token.html	141.96 KB	141.96 KB	0 bytes (0%)
eth_balance_checker.html	21.03 KB	21.03 KB	0 bytes (0%)
forwarder.html	107.42 KB	107.42 KB	0 bytes (0%)
i_asset_proxy.html	89.89 KB	89.89 KB	0 bytes (0%)
i_validator.html	26.24 KB	26.24 KB	0 bytes (0%)
i_wallet.html	23.61 KB	23.61 KB	0 bytes (0%)
multi_asset_proxy.html	141.39 KB	141.39 KB	0 bytes (0%)
order_validator.html	115.34 KB	115.34 KB	0 bytes (0%)
weth9.html	129.04 KB	129.04 KB	0 bytes (0%)
zrx_token.html	107.34 KB	107.34 KB	0 bytes (0%)
dev_utils.html	339.53 KB	339.53 KB	0 bytes (0%)

packages/abi-gen/package.json

coveralls · 2019-08-28T22:24:55Z

Coverage decreased (-2.7%) to 77.532% when pulling c53002a on multilang-1872/evm into 5d6584b on development.

packages/abi-gen/templates/TypeScript/contract.handlebars

packages/abi-gen/test-cli/test_typescript/test/abi_gen_dummy_test.ts

packages/0x.js/webpack.config.js

jalextowle

This looks great! I'm really looking forward to using this to speed up our tests 🎉

contracts/utils/test/lib_address_array.ts

jalextowle · 2019-08-30T19:48:23Z

contracts/utils/test/lib_bytes.ts

-    typeEncodingUtils,
-    web3Wrapper,
-} from '@0x/contracts-test-utils';
+import { chaiSetup, constants, provider, txDefaults, typeEncodingUtils, web3Wrapper } from '@0x/contracts-test-utils';


Same as above (it's optional, but very nice).

packages/base-contract/src/index.ts

packages/abi-gen/templates/TypeScript/partials/method_call_pure.handlebars

xianny · 2019-09-06T19:05:31Z

Ready for re-review. I rebased off development and force-pushed the rebase. New changes are 62d7cd5 and 5ead509

fabioberger · 2019-09-09T09:04:21Z

packages/0x.js/webpack.config.js

@@ -39,6 +39,9 @@ module.exports = {
            }),
        ],
    },
+    node: {
+        fs: 'empty',
+    },


I'm still worried about this hack. Does this mean anyone using 0x.js in a webpack project will need to do this too to get it to work? If so, please add browser-specific instructions to the README explaining the need for this step.

I created a test project importing 0x.js and tried bundling with webpack. Sadly yes and there doesn't seem to be any workaround as long as we are using ethereumjs-vm as a dependency. I'll add instructions to the README.

* Added longer timeout for algolia admin operations. Added an option to apply hidden and custom labels to filters from algolia. Added sorting guides (alphabetically) and tools (by community maintenance and alphabetically). * Fixed some types in guides * Updated webpack, webpack-dev-server, webpack-bundle-analyzer, webpack-cli versions * Updated / cleaned up babel and mdx packages * Updated terser webpack plugin; Removed uglify plugin (unused). Added parallel option for terser. Added target browsers and cache directory option for babel-loader * Webpack changes: using eval-source-map for development, added parallel option to Terser plugin, added cache loader and caching directory to mdx / babel loaders. * Removed unusued pkg: body-scroll-lock * Removed unused jsonschema / @types/jsonschema packages * Removed unused less node package, adjusted less loader rules to match other loaders in webpack config * Removed unusued node-sass package. Left sass-loader for webpack intact. * Removed unused package react-lazyload * Removed unused package react-typist * Removed react-tap-event types as it's not used anymore. Reinstalled node-sass as a dev dependency as it's needed by sass-loader * Moves @0x/types and @0x/typescript-typings to devDependencies * Replaced react loadable (only used in Icon) with the native react lazy / suspense. Removed loadable nad its types from package.json * Removed unused make-promises-safe package * Moved animations to public and compressed files * Added opening step links in new tab if the url is valid * Moved @0x/types back to dependencies. * Added animation wrapper with positioning props. Updated animations for core concepts. * Replaced images for core concepts. Fixed a bug causing duplicate props on image and its container in mdx * Remove legacy FAQ * Update yarn.lock * Add MD docs diff test to CI * Remove unused dep * Update docs to latest format * Update yarn.lock * Update ts-doc-gen with fix for multi-link lines * Final docs gen * Fix home route * Update yarn.lock * Add Golang Mesh RPC package and update versions * Update the tools MDX files from authoritative S3 before build and dev server start * Gitignore the tool MDX files in website repo * Redirect old docs pages and wiki to new doc pages * Move out Algolia indexing command-line tool out of website and remove need to expose admin key * Add updating tools from S3 and indexing content on Algolia to deployment commands * Add note about admin API env var needed for indexing docs * Remove scripts gitignore since we don't have monorepo scripts in each package anymore * Segregate indexes by environment * Fixed 404 display for docs pages * Removed webpack bundle analyzer * Fix search and indexing * Use `yarn` because otherwise the flags don't get passed down properly * Improve indexing comment * Remove legacy doc pages * Fix linter errors * Fix clean command to remove bundles recursively * Revert react and react-dom versions in Instant * Remove old doc md files * Fix links * Fix prettier * Combine @0x/utils exports * Update doc links * Remove unused components * Fix TS error * Add missing new line * Update Guides * Ignore auto-generated MDX in website repo * Prettier fix * Add all guides to the sitemap.txt * Add MMing guide * Fix Get Started links * Add 0x Extensions guide * Replace all links to wiki with links to guides section * Fix all /docs/{pkg} links to /docs/tools/{pkg} * Remove deployer endpoint that is no longer used * Fix links in Core Concepts * Fixed regex to not remove hashes on links beyond the initial one * Fixed huge width on instant screenshot * Cleaned up core concept illustrations * Started updating tool titles * Fixed sectionizing headings in docs: Nested sections do not get wrapped in parent sections anymore; only sectionizing headings that need to be sectionized (i.e. that appear in the table of contents) * Stylstic fix for the new way we sectionize headings / table of contents * Change CoordinatorWrapper constructor to take a provider * Added autolinking headings in mdx docs * Refactor doc generation script to only generate MD docs and to have them reflect what is exported in their respective index.ts files * Update ts-doc-gen * Pass in provider, not Web3Wrapper * Add back logic to prune out private methods * Write algolia_metadata to utils dir * Remove duplicate algolia_meta * Add more packages to those we generate docs for and remove unused flags * Update reference.mdx files * Hide tools from homepage that have isHidden flag * Link 0x.js to it's reference page * Update tool naming to be more human readable * Remove order-watcher reference doc * Add blurb about on-chain API Explorer * Add "On-chain" prefix to section name * Remove committed reference file * Sorting guides by difficulty and alphabetically * Pushed sorting guides titles case-insensitive * Sorting tools by difficulty and alphabetically. Removed icons from featured tools. Extracted common difficultyOrder constant * Update ts-doc-gen so that it properly converts module relative links to anchor links * Update doc references * Remove "Relayers" topic/tag * Prettier fix * Remove hr so we don't have a bunch in a row * Cleaned up CLI tag and added link to tools on API page * Cleaned up some Guide titles * Added bug bounty program guide * Fixed a bug in algolia_meta * Thrid level of nesting / temporary webpack config * Open help link in new tab * Link Python tools to doc pages not PyPi * Fix links in guides * Remove unused variables * Revert webpack config * Extracted common styles for levels of nesting deeper than 1 in the mdx table of contents * Smoother animation on active table of contents state change * Autolink headings in mdx only up to h3. Added heading sizes (in px) for h4,h5,h6 in mdx headings * Fix prettier * Adjusted font-size for paragraph, ordered and unordered lists. Fixed line-heights and colors too. * Update ts-doc-gen and the reference docs * Replace 0xproject.com urls with 0x.org * Update README links * Fix header sizes to display optimally in sidebar * Fixed an issue with other nodes than text being parsed incorrectly in the table of contents * Fixed styles for table of contents * Use a different babel plugin that works in a production webpack build * Unbroke build process / generating toc * Changed line-height to 1.6 for paragraph * Adjust scrollbar / toc height to available space * Fixed some types * Remove unnecessary link * Fix casing on TypeScript * Fix casing of PyPI * Remove doc gen from abi-gen-wrappers since it'll be tested via contract-wrappers * Fix MD docs and make sure generated contract wrappers are being rendered * Remove generated docs in clean * Correctly copying code samples * Several additional fixes to the reference MDX docs * Changed tools to Tools & Libraries - top nav left as just tools * Changed references from Asset Buyer to Asset Swapper * Changed trader keyword to trading * Nevermind, changed back to Trader * Sneaking in updated product dropdown menu titles based on Will's feedback * Removed the word wiki from resources dropdown * Open legal guide in same window * Removed the isCommunity filter / custom filter labels functionality (only used for that before) * Update ts-doc-gen version to one that fixes issues with Object Literals and removes Hierarchy sections and Module headers * update yarn.lock * Remove unused code * Remove unused import * Remove unused imports * Remove unused import * Fix prettier * Update outdating dep version * Created a color scheme for code snippets. Fixed language not being passed to some code blocks in two guides. * Update abi-gen-wrappers dep version * Update Algolia to production account * Fix prettier * Fix prettier in algolia_meta * Remove packages/dev-tools-pages folder and update yarn.lock * Remove other random references to dev-tools-pages * Fix website * Changed the order of indices in search suggestions * Removed a comment * Added scrollbar size adjustment on resize / scroll * Rendering sidebar on mobile without any event listeners / taxing calculations / changes in height * Added a performance comment * Simplified table of contents * Update ganache-cli to later version * Remove bundle dirs too * Added keeping active link in view when scrolling content in the docs * Increase available memory for webpack * Update contract addresses * Update market-making guide to mention Mesh as an alternative to SRA * Update Web3 Provider Explained guide * Re-wrote Ganache Setup guide into a Setting up a local 0x testnet guide * Export more of abi-gen-wrappers from contract-wrappers * Final update of reference docs * Add contract-wrappers MD docs and update it's index.ts so that no types are missing * Fix prettier * Increase the memory allocation for building the website * Remove use of remove type * Check if link is a valid url in mdx inline link: if so, open in a new tab, if not, same tab. * Print out which snapshot version is being downloaded * Updated CHANGELOGS & MD docs * Publish - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - [email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - [email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] * Remove the website from the monorepo * Update yarn.lock * Remove website files that were accidentally merged back in * Use local EVM for pure functions (#2108) * add local evm for pure functions * increase container size to >=8gb for static-tests * increase max bundle size because of ethereumjs-vm dependency * add declarations for ethereumjs-vm in @0x/typescript-typings * Make `OrdersChannelSubscriptionOpts` conform to SRAv2 * Make it easier to use validateOrderFillableOrThrowAsync (#2096) * make it easier to use validateOrderFillableOrThrowAsync * add unit tests, use DevUtils * remove dependency on @0x/order-utils from @0x/migrations * add devUtils to contract-wrappers (#2146) * Delete docs in S3 bucket before uploading latest version so we only ever have one version uploaded at a time * Update to new ts-doc-gen version that fixes links in "Inherited from" lines * try to fix instant build * Remove redoc-cli as a dep from sra-spec * Smooth out some last incompatible types * Fix prettier * Add terser-webpack-plugin to 0x.js deps * @0x/orderbook * AssetSwapper to use @0x/orderbook * Remove unused imported type * Prevent double websocket connections * Fix build error * fixed consumer inconsistency bug * linted + added convenience functionality * minor changes/typo fixes * updated websocket * updated for prettier * Fix versions and exported types * move log tests to @0x/abi-gen; delete exchange_wrapper_test (#2160) * Remove unused exported types * Fix exports from asset-swapper * Update exported types for docs * Update mesh client dep * Move perPage and 18 precision lower to re-use * fix ABI encoding/decoding functions (#2165) * Fix typo at contract import (#2102) * Updated CHANGELOGS & MD docs * Publish - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - [email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - [email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] - @0x/[email protected] * fix circleci diff * update changelog

xianny requested a review from feuGeneA as a code owner August 28, 2019 21:55

xianny force-pushed the multilang-1872/evm branch from d6aec28 to c1322c5 Compare August 28, 2019 22:12

xianny requested review from BMillman19, fabioberger, fragosti and steveklebanoff as code owners August 28, 2019 22:12

xianny requested review from dekz and removed request for steveklebanoff, BMillman19 and fragosti August 28, 2019 22:19

xianny force-pushed the multilang-1872/evm branch from c1322c5 to ef91055 Compare August 28, 2019 22:21

xianny commented Aug 28, 2019

View reviewed changes

packages/abi-gen/package.json Show resolved Hide resolved

xianny commented Aug 28, 2019

View reviewed changes

packages/abi-gen/package.json Show resolved Hide resolved

xianny commented Aug 28, 2019

View reviewed changes

packages/abi-gen/templates/TypeScript/contract.handlebars Show resolved Hide resolved

xianny commented Aug 28, 2019

View reviewed changes

packages/abi-gen/test-cli/test_typescript/test/abi_gen_dummy_test.ts Show resolved Hide resolved

xianny force-pushed the multilang-1872/evm branch from ef91055 to 6916f18 Compare August 28, 2019 22:36

xianny requested review from abandeali1 and hysz as code owners August 28, 2019 22:36

xianny force-pushed the multilang-1872/evm branch from 6916f18 to 1a70df6 Compare August 28, 2019 22:38

xianny removed request for abandeali1 and hysz August 28, 2019 22:39

xianny force-pushed the multilang-1872/evm branch 4 times, most recently from d0a1fbd to 4858ef9 Compare August 29, 2019 16:49

xianny requested a review from jalextowle August 29, 2019 16:49

xianny force-pushed the multilang-1872/evm branch from 4858ef9 to bf925a1 Compare August 29, 2019 17:29

xianny commented Aug 29, 2019

View reviewed changes

packages/0x.js/webpack.config.js Show resolved Hide resolved

xianny force-pushed the multilang-1872/evm branch from 6207cd2 to 7e30315 Compare August 30, 2019 18:40

jalextowle approved these changes Aug 30, 2019

View reviewed changes

xianny self-assigned this Sep 3, 2019

xianny force-pushed the multilang-1872/evm branch from 7e30315 to 60577f0 Compare September 5, 2019 22:41

xianny added 2 commits September 5, 2019 15:44

add local evm for pure functions

2f5f9c6

increase container size to >=8gb for static-tests

e0a4c82

xianny force-pushed the multilang-1872/evm branch 4 times, most recently from 461b4fb to 1609cac Compare September 6, 2019 17:32

increase max bundle size because of ethereumjs-vm dependency

1c5de77

xianny force-pushed the multilang-1872/evm branch 2 times, most recently from 384ecba to f50b6de Compare September 6, 2019 17:55

xianny mentioned this pull request Sep 6, 2019

Make it easier to use validateOrderFillableOrThrowAsync #2096

Merged

4 tasks

xianny added 2 commits September 6, 2019 11:59

add declarations for ethereumjs-vm in @0x/typescript-typings

62d7cd5

add changelogs

5ead509

xianny force-pushed the multilang-1872/evm branch from f50b6de to 5ead509 Compare September 6, 2019 19:03

xianny requested a review from fabioberger September 6, 2019 19:03

xianny mentioned this pull request Sep 7, 2019

Remove redundant logic in order-utils #2137

Closed

fabioberger approved these changes Sep 9, 2019

View reviewed changes

tweak to webpack configs and README

456669f

xianny force-pushed the multilang-1872/evm branch from a4f2f9b to 456669f Compare September 9, 2019 18:49

prettier

c53002a

xianny merged commit d912175 into development Sep 9, 2019

xianny deleted the multilang-1872/evm branch September 9, 2019 19:24

xianny mentioned this pull request Sep 18, 2019

Add deployedBytecode to contract-artifacts #2173

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use local EVM for pure functions #2108

Use local EVM for pure functions #2108

xianny commented Aug 28, 2019 •

edited

Loading

buildsize bot commented Aug 28, 2019 •

edited

Loading

coveralls commented Aug 28, 2019 •

edited

Loading

jalextowle left a comment

jalextowle Aug 30, 2019

xianny commented Sep 6, 2019

fabioberger Sep 9, 2019

xianny Sep 9, 2019

Use local EVM for pure functions #2108

Use local EVM for pure functions #2108

Conversation

xianny commented Aug 28, 2019 • edited Loading

Description

Testing instructions

Types of changes

Checklist:

buildsize bot commented Aug 28, 2019 • edited Loading

coveralls commented Aug 28, 2019 • edited Loading

jalextowle left a comment

Choose a reason for hiding this comment

jalextowle Aug 30, 2019

Choose a reason for hiding this comment

xianny commented Sep 6, 2019

fabioberger Sep 9, 2019

Choose a reason for hiding this comment

xianny Sep 9, 2019

Choose a reason for hiding this comment

xianny commented Aug 28, 2019 •

edited

Loading

buildsize bot commented Aug 28, 2019 •

edited

Loading

coveralls commented Aug 28, 2019 •

edited

Loading