Merge pull request #37 from 0xProject/fix/encoding-rules-export

export and `EncodingRules` from utils
0xProject · Apr 26, 2021 · a5a594b · a5a594b
2 parents 6a16a67 + 25c6f3b
commit a5a594b
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 5 deletions.
diff --git a/abi-gen/CHANGELOG.json b/abi-gen/CHANGELOG.json
@@ -1,4 +1,13 @@
 [
+    {
+        "version": "5.5.2",
+        "changes": [
+            {
+                "note": "Use `EncodingRules` instead of `AbiEncoder.EncodingRules` in templates",
+                "pr": 37
+            }
+        ]
+    },
     {
         "timestamp": 1619466964,
         "version": "5.5.1",

diff --git a/abi-gen/templates/TypeScript/contract.handlebars b/abi-gen/templates/TypeScript/contract.handlebars
@@ -29,7 +29,7 @@ import {
     TxAccessListWithGas,
     SupportedProvider,
 } from 'ethereum-types';
-import { AbiEncoder, BigNumber, classUtils, hexUtils, logUtils, providerUtils } from '@0x/utils';
+import { AbiEncoder, BigNumber, classUtils, EncodingRules, hexUtils, logUtils, providerUtils } from '@0x/utils';
 import { EventCallback, IndexedFilterValues, SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import { assert } from '@0x/assert';
@@ -381,7 +381,7 @@ export class {{contractName}}Contract extends BaseContract {
         txDefaults?: Partial<TxData>,
         logDecodeDependencies?: { [contractName: string]: ContractAbi },
         deployedBytecode: string | undefined = {{contractName}}Contract.deployedBytecode,
-        encodingRules?: AbiEncoder.EncodingRules,
+        encodingRules?: EncodingRules,
     ) {
         super('{{contractName}}', {{contractName}}Contract.ABI(), address, supportedProvider, txDefaults, logDecodeDependencies, deployedBytecode, encodingRules);
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', '_web3Wrapper']);

diff --git a/abi-gen/test-cli/output/typescript/abi_gen_dummy.ts b/abi-gen/test-cli/output/typescript/abi_gen_dummy.ts
@@ -29,7 +29,7 @@ import {
     TxAccessListWithGas,
     SupportedProvider,
 } from 'ethereum-types';
-import { BigNumber, classUtils, hexUtils, logUtils, providerUtils } from '@0x/utils';
+import { AbiEncoder, BigNumber, classUtils, EncodingRules, hexUtils, logUtils, providerUtils } from '@0x/utils';
 import { EventCallback, IndexedFilterValues, SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import { assert } from '@0x/assert';
@@ -2140,6 +2140,7 @@ export class AbiGenDummyContract extends BaseContract {
         txDefaults?: Partial<TxData>,
         logDecodeDependencies?: { [contractName: string]: ContractAbi },
         deployedBytecode: string | undefined = AbiGenDummyContract.deployedBytecode,
+        encodingRules?: EncodingRules,
     ) {
         super(
             'AbiGenDummy',
@@ -2149,6 +2150,7 @@ export class AbiGenDummyContract extends BaseContract {
             txDefaults,
             logDecodeDependencies,
             deployedBytecode,
+            encodingRules,
         );
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', '_web3Wrapper']);
         this._subscriptionManager = new SubscriptionManager<AbiGenDummyEventArgs, AbiGenDummyEvents>(

diff --git a/abi-gen/test-cli/output/typescript/lib_dummy.ts b/abi-gen/test-cli/output/typescript/lib_dummy.ts
@@ -27,7 +27,7 @@ import {
     TxAccessListWithGas,
     SupportedProvider,
 } from 'ethereum-types';
-import { BigNumber, classUtils, hexUtils, logUtils, providerUtils } from '@0x/utils';
+import { AbiEncoder, BigNumber, classUtils, EncodingRules, hexUtils, logUtils, providerUtils } from '@0x/utils';
 import { EventCallback, IndexedFilterValues, SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import { assert } from '@0x/assert';
@@ -222,6 +222,7 @@ export class LibDummyContract extends BaseContract {
         txDefaults?: Partial<TxData>,
         logDecodeDependencies?: { [contractName: string]: ContractAbi },
         deployedBytecode: string | undefined = LibDummyContract.deployedBytecode,
+        encodingRules?: EncodingRules,
     ) {
         super(
             'LibDummy',
@@ -231,6 +232,7 @@ export class LibDummyContract extends BaseContract {
             txDefaults,
             logDecodeDependencies,
             deployedBytecode,
+            encodingRules,
         );
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', '_web3Wrapper']);
         LibDummyContract.ABI().forEach((item, index) => {

diff --git a/abi-gen/test-cli/output/typescript/test_lib_dummy.ts b/abi-gen/test-cli/output/typescript/test_lib_dummy.ts
@@ -27,7 +27,7 @@ import {
     TxAccessListWithGas,
     SupportedProvider,
 } from 'ethereum-types';
-import { BigNumber, classUtils, hexUtils, logUtils, providerUtils } from '@0x/utils';
+import { AbiEncoder, BigNumber, classUtils, EncodingRules, hexUtils, logUtils, providerUtils } from '@0x/utils';
 import { EventCallback, IndexedFilterValues, SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import { assert } from '@0x/assert';
@@ -315,6 +315,7 @@ export class TestLibDummyContract extends BaseContract {
         txDefaults?: Partial<TxData>,
         logDecodeDependencies?: { [contractName: string]: ContractAbi },
         deployedBytecode: string | undefined = TestLibDummyContract.deployedBytecode,
+        encodingRules?: EncodingRules,
     ) {
         super(
             'TestLibDummy',
@@ -324,6 +325,7 @@ export class TestLibDummyContract extends BaseContract {
             txDefaults,
             logDecodeDependencies,
             deployedBytecode,
+            encodingRules,
         );
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', '_web3Wrapper']);
         TestLibDummyContract.ABI().forEach((item, index) => {

diff --git a/utils/CHANGELOG.json b/utils/CHANGELOG.json
@@ -1,4 +1,13 @@
 [
+    {
+        "version": "6.4.2",
+        "changes": [
+            {
+                "note": "Export `EncodingRules` and `DecodingRules` at the root level",
+                "pr": 37
+            }
+        ]
+    },
     {
         "version": "6.4.1",
         "changes": [

diff --git a/utils/src/index.ts b/utils/src/index.ts
@@ -15,6 +15,7 @@ export { fetchAsync } from './fetch_async';
 export { signTypedDataUtils } from './sign_typed_data_utils';
 export { hexUtils } from './hex_utils';
 export import AbiEncoder = require('./abi_encoder');
+export { EncodingRules, DecodingRules } from './abi_encoder';
 export * from './types';
 export { generatePseudoRandom256BitNumber } from './random';
 export {