Use hardcoded deployedBytecode for local EVM execution #2198

xianny · 2019-09-24T18:13:22Z

Description

Resolves #2192

Try to use hardcoded deployedBytecode wherever possible for local EVM execution.

This means that we are able to instantiate wrappers and call pure functions completely locally.

E.g. in a unit testing scenario, we should now be able to do this:

const address = constants.NULL_ADDRESS;
const supportedProvider = someProvider;
const devUtils = new DevUtils(address, supportedProvider);
const assetData = devUtils.encodeERC20AssetData.callAsync(zrxTokenAddress);

Without this PR, one would have to supply a valid address with a DevUtils contract deployed, in order to use any of the pure functions therein. You could still do this locally by deploying an instance of the contract on Ganache, but would introduce dependencies on Ganache, @0x/migrations, blah blah.

Note that the deployedBytecode is now hardcoded within the contract wrappers. If a developer is making changes to the contract, they would need to regenerate the contract wrapper using the abi-gen utility to have the changes reflected.

Testing instructions

Types of changes

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-09-24T18:13:49Z

File name	Previous Size	New Size	Change
init.py	7.04 KB	7.04 KB	0 bytes (0%)
abi_gen_dummy.ts	164.71 KB	175.19 KB	10.48 KB (6%)
lib_dummy.ts	4.84 KB	5.24 KB	416 bytes (8%)
test_lib_dummy.ts	13.44 KB	14.02 KB	597 bytes (4%)

coveralls · 2019-09-25T00:07:43Z

Coverage remained the same at 72.355% when pulling 8e07395 on 2192-fix-eth-call into a347c1e on 3.0.

feuGeneA · 2019-09-25T16:24:47Z

contracts/asset-proxy/test/static_call_proxy.ts

+            provider,
+            txDefaults,
+            {},
+            StaticCallProxyContract.deployedBytecode,


Any reason to specify this line here? It would default to this value, right?

Nope it would default to IAssetProxyContract.deployedBytecode, which was causing it to fail before!

feuGeneA · 2019-09-25T16:26:35Z

packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class CoordinatorContract extends BaseContract {
+    public static deployedBytecode = '';


feuGeneA · 2019-09-25T16:27:03Z

packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts

@@ -46,6 +46,7 @@ export interface CoordinatorRegistryCoordinatorEndpointSetEventArgs extends Deco
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class CoordinatorRegistryContract extends BaseContract {
+    public static deployedBytecode = '';


feuGeneA · 2019-09-25T16:28:15Z

packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class DutchAuctionContract extends BaseContract {
+    public static deployedBytecode = '';


feuGeneA · 2019-09-25T16:30:40Z

packages/abi-gen-wrappers/src/generated-wrappers/i_asset_proxy.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class IAssetProxyContract extends BaseContract {
+    public static deployedBytecode = '0x';


why does this sometimes generate as ''' and sometimes as '0x'?

feuGeneA · 2019-09-25T16:31:01Z

packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class IValidatorContract extends BaseContract {
+    public static deployedBytecode = '';


feuGeneA · 2019-09-25T16:31:52Z

packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class IWalletContract extends BaseContract {
+    public static deployedBytecode = '0x';


why does this sometimes generate as ''' and sometimes as '0x'?

feuGeneA · 2019-09-25T16:32:21Z

packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts

@@ -28,6 +28,7 @@ import * as ethers from 'ethers';
 // tslint:disable:no-parameter-reassignment
 // tslint:disable-next-line:class-name
 export class OrderValidatorContract extends BaseContract {
+    public static deployedBytecode = '';


packages/abi-gen/src/index.ts

feuGeneA · 2019-09-25T16:40:10Z

packages/base-contract/src/index.ts

    ) {
        assert.isString('contractName', contractName);
        assert.isETHAddressHex('address', address);
+        if (deployedBytecode !== undefined) {
+            assert.isHexString('deployedBytecode', deployedBytecode);
+        }


Are tests running? Wouldn't this fail tests of the generated wrappers that have their deployedBytecode initialized to ''?

xianny · 2019-09-25T18:44:43Z

Updated to not allow bytecode to be initialised as empty string or 0x

xianny · 2019-09-26T15:23:34Z

Updates:
If there's no valid deployedBytecode, then it will be generated like this:

public static deployedBytecode: string | undefined;

otherwise it will be

public static deployedBytecode = '0x123456....';

Warnings look like this now:

xianny requested a review from feuGeneA as a code owner September 24, 2019 18:13

xianny requested a review from hysz September 24, 2019 18:13

xianny force-pushed the 2192-fix-eth-call branch 3 times, most recently from fe2bd6b to d19f277 Compare September 24, 2019 23:21

xianny requested a review from abandeali1 as a code owner September 24, 2019 23:21

hardcode deployedBytecode in contracts

a6ac3fd

xianny force-pushed the 2192-fix-eth-call branch from d19f277 to a6ac3fd Compare September 24, 2019 23:49

feuGeneA suggested changes Sep 25, 2019

View reviewed changes

Merge branch '3.0' into 2192-fix-eth-call

23bc086

xianny force-pushed the 2192-fix-eth-call branch from 11f5660 to c073cb5 Compare September 25, 2019 18:41

log warning if bytecode is empty or invalid

ab1ee63

xianny force-pushed the 2192-fix-eth-call branch from c073cb5 to ab1ee63 Compare September 25, 2019 18:59

hysz approved these changes Sep 25, 2019

View reviewed changes

be typesafe

8e07395

xianny merged commit cb20f03 into 3.0 Sep 26, 2019

xianny deleted the 2192-fix-eth-call branch September 26, 2019 15:38

xianny mentioned this pull request Oct 1, 2019

Add deployedBytecode to contract-artifacts #2173

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use hardcoded deployedBytecode for local EVM execution #2198

Use hardcoded deployedBytecode for local EVM execution #2198

xianny commented Sep 24, 2019

buildsize bot commented Sep 24, 2019 •

edited

Loading

coveralls commented Sep 25, 2019 •

edited

Loading

feuGeneA Sep 25, 2019

xianny Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

feuGeneA Sep 25, 2019

xianny commented Sep 25, 2019

xianny commented Sep 26, 2019

Use hardcoded deployedBytecode for local EVM execution #2198

Use hardcoded deployedBytecode for local EVM execution #2198

Conversation

xianny commented Sep 24, 2019

Description

Testing instructions

Types of changes

Checklist:

buildsize bot commented Sep 24, 2019 • edited Loading

coveralls commented Sep 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xianny commented Sep 25, 2019

xianny commented Sep 26, 2019

buildsize bot commented Sep 24, 2019 •

edited

Loading

coveralls commented Sep 25, 2019 •

edited

Loading