diff options
Diffstat (limited to 'packages/dev-tools-pages/ts/pages/coverage.tsx')
| -rw-r--r-- | packages/dev-tools-pages/ts/pages/coverage.tsx | 179 |
1 files changed, 0 insertions, 179 deletions
diff --git a/packages/dev-tools-pages/ts/pages/coverage.tsx b/packages/dev-tools-pages/ts/pages/coverage.tsx deleted file mode 100644 index 575891f3b..000000000 --- a/packages/dev-tools-pages/ts/pages/coverage.tsx +++ /dev/null @@ -1,179 +0,0 @@ -import * as React from 'react'; -import { hydrate, render } from 'react-dom'; -import * as Loadable from 'react-loadable'; - -import { context } from 'ts/context/coverage'; - -import { Base } from 'ts/components/base'; -import { Breakout } from 'ts/components/breakout'; -import { CallToAction } from 'ts/components/call_to_action'; -import { Code } from 'ts/components/code'; -import { Content } from 'ts/components/content'; -import { ContentBlock } from 'ts/components/content-block'; -import { Hero } from 'ts/components/hero'; -import { InlineCode } from 'ts/components/inline-code'; -import { Intro, IntroAside, IntroLead } from 'ts/components/intro'; -import { List, ListItem } from 'ts/components/list'; -import { TabBlock, Tabs } from 'ts/components/tabs'; - -const Animation = Loadable({ - loader: () => System.import(/* webpackChunkName: 'cov-animation' */ 'ts/components/animations/cov'), - loading: () => <div />, - delay: 1000, - render(loadable: { CovAnimation: any }): React.ReactNode { - const Component = loadable.CovAnimation; - return <Component />; - }, -}); - -const Coverage: React.StatelessComponent<{}> = () => ( - <Base context={context}> - <Hero> - <Animation /> - </Hero> - <Intro> - <IntroLead title="Measure your tests"> - <p> - When it comes to writing secure smart contracts, testing is one of the most important steps in the - process. In order to quantify the robustness of your Solidity testing suite, you need to measure its - code coverage. - </p> - </IntroLead> - <IntroAside> - <Code - language="javascript" - isDiff={true} - gutterLength={2} - gutter={[4, undefined, 4, 4, 4, undefined, 4, 2, 2, 2]} - > - {`+function executeTransaction(uint transactionId) - public -+ notExecuted(transactionId) -+ fullyConfirmed(transactionId) -+ pastTimeLock(transactionId) -{ -+ Transaction storage tx = transactions[transactionId] -+ tx.executed = true -+ if (tx.destination.call.value(tx.value)(tx.data)) -+ Execution(transactionId) - else { -- ExecutionFailure(transactionId) -- tx.executed = false - } -}`} - </Code> - </IntroAside> - </Intro> - - <Content> - <ContentBlock main={true} title="Get started" /> - <ContentBlock title="Prerequisites"> - <List> - <ListItem> - Use{' '} - <a href="https://github.com/ethereum/go-ethereum" target="_blank"> - Geth - </a>{' '} - as a backing node. We recommend using our{' '} - <a href="https://hub.docker.com/r/0xorg/devnet" target="_blank"> - Devnet Docker container - </a>{' '} - which sets up a Geth node for testing purposes.{' '} - <a href="https://github.com/0xProject/0x-monorepo/issues/1520" target="_blank"> - Ganache support is a work in progress. - </a> - </ListItem> - <ListItem> - Understand and use{' '} - <a href="https://github.com/MetaMask/provider-engine" target="_blank"> - web3-provider-engine - </a> - . - </ListItem> - </List> - </ContentBlock> - <ContentBlock title="Installation"> - <Breakout> - <Code canCopy={true}>npm install @0x/sol-coverage --save</Code> - </Breakout> - - <p> - Sol-coverage is a subprovider that needs to be prepended to your{' '} - <a href="https://github.com/MetaMask/provider-engine" target="_blank"> - provider engine - </a> - . Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-coverage - ships with the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with{' '} - <a href="https://sol-compiler.com" target="_blank"> - Sol-compiler - </a>{' '} - and <InlineCode>TruffleArtifactAdapter</InlineCode> for use with the{' '} - <a href="https://truffleframework.com/truffle" target="_blank"> - Truffle framework - </a>{' '} - (Also see our{' '} - <a href="https://github.com/0xProject/dev-tools-truffle-example" target="_blank"> - Truffle example project - </a>{' '} - for a complete walk-through). You can also write your own and support any artifact format. - </p> - - <Tabs> - <TabBlock title="Sol-compiler"> - <Code language="javascript" canCopy={true}> - {`import { SolCompilerArtifactAdapter } from '@0x/sol-trace'; - -// Both artifactsDir and contractsDir are optional and will be fetched from compiler.json if not passed in -const artifactAdapter = new SolCompilerArtifactAdapter(artifactsDir, contractsDir);`} - </Code> - </TabBlock> - <TabBlock title="Truffle"> - <Code language="javascript" canCopy={true}> - {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; - -const projectRoot = '.'; -const solcVersion = '0.5.0'; -const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`} - </Code> - </TabBlock> - <TabBlock title="Custom"> - <Code language="javascript" canCopy={true}> - {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; - -class YourCustomArtifactsAdapter extends AbstractArtifactAdapter {...}; -const artifactAdapter = new YourCustomArtifactsAdapter(...);`} - </Code> - </TabBlock> - </Tabs> - <p> - Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} - <InlineCode>CoverageSubprovider</InlineCode> and append it to our provider engine. - </p> - - <Breakout> - <Code language="javascript" canCopy={true}> - {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; -import { CoverageSubprovider } from '@0x/sol-coverage'; - -const defaultFromAddress = "..."; // Some ethereum address with test funds -const coverageSubprovider = new CoverageSubprovider(artifactAdapter, defaultFromAddress); - -const providerEngine = new ProviderEngine(); -providerEngine.addProvider(coverageSubprovider); -providerEngine.addProvider(new RpcSubprovider({rpcUrl: 'http://localhost:8545'})); -providerEngine.start();`} - </Code> - </Breakout> - </ContentBlock> - </Content> - <CallToAction /> - </Base> -); - -const root = document.getElementById('app'); - -if (root.hasChildNodes()) { - hydrate(<Coverage />, root); -} else { - render(<Coverage />, root); -} |