Merge pull request #1298 from 0xProject/fix/artifact-type-error

Fix Artifact Interface Type Issue

packages/abi-gen-wrappers/CHANGELOG.json

@@ -1,4 +1,14 @@
 [
+    {
+        "version": "1.1.0",
+        "changes": [
+            {
+                "note":
+                    "`deployFrom0xArtifactAsync` additionally accepts artifacts that conform to the `SimpleContractArtifact` interface",
+                "pr": 1298
+            }
+        ]
+    },
     {
         "timestamp": 1542208198,
         "version": "1.0.5",

packages/abi-gen-wrappers/package.json

@@ -32,6 +32,7 @@
     "devDependencies": {
         "@0x/abi-gen": "^1.0.16",
         "@0x/tslint-config": "^1.0.10",
+        "@0x/types": "^1.2.1",
         "@0x/utils": "^2.0.5",
         "@0x/web3-wrapper": "^3.1.4",
         "ethereum-types": "^1.1.2",

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -1800,7 +1801,7 @@ export class AssetProxyOwnerContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
             _owners: string[],

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -968,7 +969,7 @@ export class DummyERC20TokenContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
             _name: string,

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -1264,7 +1265,7 @@ export class DummyERC721TokenContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
             _name: string,

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -601,7 +602,7 @@ export class ERC20ProxyContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ERC20ProxyContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -508,7 +509,7 @@ export class ERC20TokenContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ERC20TokenContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -601,7 +602,7 @@ export class ERC721ProxyContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ERC721ProxyContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -845,7 +846,7 @@ export class ERC721TokenContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ERC721TokenContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -3024,7 +3025,7 @@ export class ExchangeContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ExchangeContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -661,7 +662,7 @@ export class ForwarderContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
             _exchange: string,

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -60,7 +61,7 @@ export class IValidatorContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<IValidatorContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -55,7 +56,7 @@ export class IWalletContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<IWalletContract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -295,7 +296,7 @@ export class OrderValidatorContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
             _exchange: string,

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -787,7 +788,7 @@ export class WETH9Contract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<WETH9Contract> {

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

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -598,7 +599,7 @@ export class ZRXTokenContract extends BaseContract {
         },
     };
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
     ): Promise<ZRXTokenContract> {

packages/contract_templates/contract.handlebars

@@ -4,6 +4,7 @@
 import { BaseContract } from '@0x/base-contract';
 import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
 import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
 import * as _ from 'lodash';
@@ -40,7 +41,7 @@ export class {{contractName}}Contract extends BaseContract {
     {{/this.constant}}
 {{/each}}
     public static async deployFrom0xArtifactAsync(
-        artifact: ContractArtifact,
+        artifact: ContractArtifact | SimpleContractArtifact,
         provider: Provider,
         txDefaults: Partial<TxData>,
         {{> typed_params inputs=ctor.inputs}}

packages/types/CHANGELOG.json

@@ -1,4 +1,14 @@
 [
+    {
+        "version": "1.3.0",
+        "changes": [
+            {
+                "note":
+                    "Add the `SimpleContractArtifact` type, which describes the artifact format published in the `@0x/contract-artifacts` package",
+                "pr": 1298
+            }
+        ]
+    },
     {
         "version": "1.2.1",
         "changes": [

packages/types/src/index.ts

@@ -1,7 +1,7 @@
 // tslint:disable:max-file-line-count
 
 import { BigNumber } from 'bignumber.js';
-import { ContractAbi } from 'ethereum-types';
+import { ContractAbi, ContractNetworks, DevdocOutput } from 'ethereum-types';
 
 // HACK: Rather then extending from OrderWithoutExchangeAddress
 // we don't, because our docs don't expand inherited types, and it's unnecessarily
@@ -626,3 +626,24 @@ export interface EIP712TypedData {
 export interface Stats {
     orderCount: number;
 }
+
+export interface SimpleContractArtifact {
+    schemaVersion: string;
+    contractName: string;
+    compilerOutput: SimpleStandardContractOutput;
+    networks: ContractNetworks;
+}
+
+export interface SimpleStandardContractOutput {
+    abi: ContractAbi;
+    evm: SimpleEvmOutput;
+    devdoc?: DevdocOutput;
+}
+
+export interface SimpleEvmOutput {
+    bytecode: SimpleEvmBytecodeOutput;
+}
+
+export interface SimpleEvmBytecodeOutput {
+    object: string;
+}