diff options
Diffstat (limited to 'packages/metacoin')
-rw-r--r-- | packages/metacoin/README.md | 14 | ||||
-rw-r--r-- | packages/metacoin/test/global_hooks.ts | 2 | ||||
-rw-r--r-- | packages/metacoin/test/metacoin_test.ts | 1 | ||||
-rw-r--r-- | packages/metacoin/test/utils/web3_wrapper.ts | 4 |
4 files changed, 11 insertions, 10 deletions
diff --git a/packages/metacoin/README.md b/packages/metacoin/README.md index 8f45154d7..15816cc67 100644 --- a/packages/metacoin/README.md +++ b/packages/metacoin/README.md @@ -1,14 +1,14 @@ ## @0xproject/metacoin -This is a small example project that server as a showroom/polygon for 0x dev tools. -It suppports: +This is an example project that demonstrates how the many Ethereum dev tools developed by 0x can be used in any Solidity/TS project. +It supports: * Compiling & testing smart contracts -* Typed contract wrappers -* Coverage -* Profiling +* Generating typed contract wrappers +* Solidity coverage +* Solidity gas profiling * Running tests against Ganache -* Running tests against our fork of Geth that supports snapshots & time travel +* Running tests against our fork of Geth (it supports snapshotting & time travel) ## Contributing @@ -81,7 +81,7 @@ yarn coverage:report:html ### Profiling -Please note that traces emmited by ganache have incorrect gas costs so we recommend using Geth for profiling. +Please note that traces emitted by ganache have incorrect gas costs so we recommend using Geth for profiling. ```bash TEST_PROVIDER=geth yarn test:profile diff --git a/packages/metacoin/test/global_hooks.ts b/packages/metacoin/test/global_hooks.ts index 4ab2ddc2f..7328531e4 100644 --- a/packages/metacoin/test/global_hooks.ts +++ b/packages/metacoin/test/global_hooks.ts @@ -3,7 +3,7 @@ import { env, EnvVars } from '@0xproject/dev-utils'; import { coverage } from './utils/coverage'; import { profiler } from './utils/profiler'; -after('generate coverage & profiler report', async () => { +after('generate coverage || profiler report', async () => { if (env.parseBoolean(EnvVars.SolidityCoverage)) { const coverageSubprovider = coverage.getCoverageSubproviderSingleton(); await coverageSubprovider.writeCoverageAsync(); diff --git a/packages/metacoin/test/metacoin_test.ts b/packages/metacoin/test/metacoin_test.ts index 22e63eead..78de57a2a 100644 --- a/packages/metacoin/test/metacoin_test.ts +++ b/packages/metacoin/test/metacoin_test.ts @@ -10,6 +10,7 @@ import { MetacoinContract, TransferContractEventArgs } from '../src/contract_wra import { chaiSetup } from './utils/chai_setup'; import { config } from './utils/config'; +// Comment out the next line enable profiling // import { profiler } from './utils/profiler'; import { provider, web3Wrapper } from './utils/web3_wrapper'; diff --git a/packages/metacoin/test/utils/web3_wrapper.ts b/packages/metacoin/test/utils/web3_wrapper.ts index c09f8d2df..9bc3d05ac 100644 --- a/packages/metacoin/test/utils/web3_wrapper.ts +++ b/packages/metacoin/test/utils/web3_wrapper.ts @@ -1,6 +1,6 @@ import { env, EnvVars } from '@0xproject/dev-utils'; import { GanacheSubprovider, prependSubprovider } from '@0xproject/subproviders'; -import { logUtils } from '@0xproject/utils'; +import { logUtils, errorUtils } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as fs from 'fs'; import ProviderEngine = require('web3-provider-engine'); @@ -27,7 +27,7 @@ switch (process.env.TEST_PROVIDER) { testProvider = ProviderType.Geth; break; default: - throw new Error(`Unknown TEST_PROVIDER: ${process.env.TEST_PROVIDER}`); + throw errorUtils.spawnSwitchErr('TEST_PROVIDER', process.env.TEST_PROVIDER); } export const provider = new ProviderEngine(); |