diff options
Diffstat (limited to 'packages/dev-tools-pages/ts')
22 files changed, 275 insertions, 149 deletions
diff --git a/packages/dev-tools-pages/ts/components/animations/index.tsx b/packages/dev-tools-pages/ts/components/animations/index.tsx index 8e5421f5c..106acf707 100644 --- a/packages/dev-tools-pages/ts/components/animations/index.tsx +++ b/packages/dev-tools-pages/ts/components/animations/index.tsx @@ -69,10 +69,7 @@ class BaseAnimation extends React.PureComponent<AnimationProps, AnimationState> } } -const Container = - styled.div < - AnimationProps > - ` +const Container = styled.div<AnimationProps>` width: 100%; height: ${props => props.height}px; position: absolute; diff --git a/packages/dev-tools-pages/ts/components/button.tsx b/packages/dev-tools-pages/ts/components/button.tsx index d3b36ebfd..ae032eb05 100644 --- a/packages/dev-tools-pages/ts/components/button.tsx +++ b/packages/dev-tools-pages/ts/components/button.tsx @@ -6,40 +6,37 @@ interface ButtonProps { large?: boolean; } -const Button = - styled.button < - ButtonProps > - ` - font-family: inherit; - line-height: 1; - font-weight: 500; - white-space: nowrap; - vertical-align: middle; - background-color: ${props => props.theme.colors.secondary}; - color: ${colors.black}; - border: 0; - border-radius: 5rem; - display: inline-flex; - justify-content: space-between; - align-items: center; - - ${props => - props.large - ? ` +const Button = styled.button<ButtonProps>` + font-family: inherit; + line-height: 1; + font-weight: 500; + white-space: nowrap; + vertical-align: middle; + background-color: ${props => props.theme.colors.secondary}; + color: ${colors.black}; + border: 0; + border-radius: 5rem; + display: inline-flex; + justify-content: space-between; + align-items: center; + + ${props => + props.large + ? ` font-size: 1rem; padding: 1.1875rem 2.375rem 1.0625rem; ` - : ` + : ` font-size: .875rem; padding: .5625rem 1.25rem; `} - :hover, :focus { - background-color: ${props => props.theme.colors.secondary_alt}; - outline: 0; - } + :hover, :focus { + background-color: ${props => props.theme.colors.secondary_alt}; + outline: 0; + } - ${media.small` + ${media.small` font-size: .875rem; padding: .5625rem 1.25rem; `} diff --git a/packages/dev-tools-pages/ts/components/call_to_action.tsx b/packages/dev-tools-pages/ts/components/call_to_action.tsx new file mode 100644 index 000000000..3805a7c8c --- /dev/null +++ b/packages/dev-tools-pages/ts/components/call_to_action.tsx @@ -0,0 +1,40 @@ +import * as React from 'react'; +import styled from 'styled-components'; + +import { ContextInterface, ThemeContext } from 'ts/context'; + +import { Button } from './button'; + +const CallToAction: React.StatelessComponent<ContextInterface> = ({ children }) => ( + <ThemeContext.Consumer> + {({ docLink }: ContextInterface) => ( + <StyledCallToAction> + <CallToActionContainer> + <Button as="a" href={docLink} target="_blank" large={true}> + Read the Docs + </Button> + </CallToActionContainer> + {children} + </StyledCallToAction> + )} + </ThemeContext.Consumer> +); + +const StyledCallToAction = styled.section` + text-align: center; + padding-top: 0; + padding-bottom: 1rem; + padding-left: 2.5rem; + padding-right: 2.5rem; + min-height: min-content; + max-height: 37.5rem; + height: 20vh; + position: relative; +`; + +const CallToActionContainer = styled.div` + margin: 0 auto; + max-width: 590px; +`; + +export { CallToAction }; diff --git a/packages/dev-tools-pages/ts/components/code.tsx b/packages/dev-tools-pages/ts/components/code.tsx index 71d7a7752..0f7d6a0cd 100644 --- a/packages/dev-tools-pages/ts/components/code.tsx +++ b/packages/dev-tools-pages/ts/components/code.tsx @@ -45,11 +45,8 @@ const Container = styled.div` } `; -const Base = - styled.div < - CodeProps > - ` - font-size: .875rem; +const Base = styled.div<CodeProps>` + font-size: 0.875rem; color: ${props => (_.isUndefined(props.language) ? colors.white : 'inherit')}; background-color: ${props => props.isLight ? 'rgba(255,255,255,.15)' : _.isUndefined(props.language) ? colors.black : '#F1F4F5'}; @@ -110,10 +107,7 @@ const StyledCodeDiff = styled(CodeDiff)` } `; -const StyledPre = - styled.pre < - CodeProps > - ` +const StyledPre = styled.pre<CodeProps>` margin: 0; ${props => !props.isDiff @@ -145,7 +139,6 @@ class Code extends React.Component<CodeProps, CodeState> { public render(): React.ReactNode { const { language, isLight, isDiff, children, gutterLength, canCopy } = this.props; const { hlCode } = this.state; - return ( <Container> <Base language={language} isDiff={isDiff} isLight={isLight}> @@ -163,7 +156,7 @@ class Code extends React.Component<CodeProps, CodeState> { <StyledCopyInput readOnly={true} aria-hidden="true" ref={this._code} value={children} /> ) : null} </Base> - {navigator.userAgent !== 'ReactSnap' && canCopy ? ( + {canCopy ? ( <Button onClick={this._handleCopyAsync.bind(this)}>{this.state.didCopy ? 'Copied' : 'Copy'}</Button> ) : null} </Container> diff --git a/packages/dev-tools-pages/ts/components/compiler.tsx b/packages/dev-tools-pages/ts/components/compiler.tsx index 694a535dd..c00e3a2b9 100644 --- a/packages/dev-tools-pages/ts/components/compiler.tsx +++ b/packages/dev-tools-pages/ts/components/compiler.tsx @@ -45,7 +45,7 @@ const Dd = styled.dd` const cards = [ { - title: 'A Project-centric', + title: 'Project-centric', body: ( <React.Fragment> Compiles an entire project instead of only individual <InlineCode isAlt={true}>.sol</InlineCode> files. @@ -54,7 +54,7 @@ const cards = [ }, { title: 'Incremental builds', - body: 'Recompiles your smart contracts after they have changed', + body: 'Only recompiles smart contracts that have been modified.', }, { title: 'Customizable artifacts', @@ -63,12 +63,16 @@ const cards = [ }, { title: 'Seamless', - body: 'Fetches and caches the required compiler binaries.', + body: 'Fetches and caches the required compiler binaries for the Solidity versions you use.', }, { title: 'Versioning', body: - 'Compiles each contract with the version specified at the top of its file (sol-compiler even supports version ranges!).', + 'Compiles each contract with the Solidity version specified at the top of its file (it even supports version ranges!).', + }, + { + title: 'Watch mode', + body: 'Have your contracts instantly recompile on file save.', }, ]; diff --git a/packages/dev-tools-pages/ts/components/container.tsx b/packages/dev-tools-pages/ts/components/container.tsx index 1b9212ed2..192d82af8 100644 --- a/packages/dev-tools-pages/ts/components/container.tsx +++ b/packages/dev-tools-pages/ts/components/container.tsx @@ -4,10 +4,7 @@ interface ContainerProps { wide?: boolean; } -const Container = - styled.div < - ContainerProps > - ` +const Container = styled.div<ContainerProps>` max-width: 77.5rem; margin: 0 auto; width: ${props => (props.wide ? '100%' : 'calc(100% - 5rem)')}; diff --git a/packages/dev-tools-pages/ts/components/content.tsx b/packages/dev-tools-pages/ts/components/content.tsx index f74e09af7..b3c353f8a 100644 --- a/packages/dev-tools-pages/ts/components/content.tsx +++ b/packages/dev-tools-pages/ts/components/content.tsx @@ -3,10 +3,7 @@ import styled from 'styled-components'; import { Container } from './container'; -const StyledMain = - styled.div < - MainProps > - ` +const StyledMain = styled.div<MainProps>` padding-top: 6.25rem; padding-bottom: 6.25rem; ${props => diff --git a/packages/dev-tools-pages/ts/components/footer.tsx b/packages/dev-tools-pages/ts/components/footer.tsx index 04fd9b88e..7e44bf128 100644 --- a/packages/dev-tools-pages/ts/components/footer.tsx +++ b/packages/dev-tools-pages/ts/components/footer.tsx @@ -3,7 +3,7 @@ import * as React from 'react'; import styled from 'styled-components'; import { context as compiler } from 'ts/context/compiler'; -import { context as cov } from 'ts/context/cov'; +import { context as coverage } from 'ts/context/coverage'; import { context as profiler } from 'ts/context/profiler'; import { context as trace } from 'ts/context/trace'; import MainIcon from 'ts/icons/logos/0x.svg'; @@ -12,7 +12,7 @@ import { media } from 'ts/variables'; import { Container } from './container'; import { Alpha, Beta } from './typography'; -const tools = [trace, cov, compiler, profiler]; +const tools = [trace, coverage, compiler, profiler]; const Footer: React.StatelessComponent<{}> = () => ( <StyledFooter> @@ -20,9 +20,9 @@ const Footer: React.StatelessComponent<{}> = () => ( <Top> <Alpha>Other tools by 0x</Alpha> <List> - {_.map(tools, ({ title, subtitle, icon }) => ( + {_.map(tools, ({ title, subtitle, icon, name }) => ( <ListItem key={title}> - <ListLink href="#"> + <ListLink href={`https://sol-${name}.com`}> <Icon as={icon as 'svg'} /> <div> <Beta>{title}</Beta> @@ -37,6 +37,10 @@ const Footer: React.StatelessComponent<{}> = () => ( <Icon as={MainIcon} /> <Small> 0x is an open, permissionless protocol allowing for tokens to be traded on the Ethereum blockchain. + Interested in joining our team?{' '} + <a href="https://0x.org/careers" target="_blank"> + We're hiring + </a> </Small> </Media> </Container> diff --git a/packages/dev-tools-pages/ts/components/header.tsx b/packages/dev-tools-pages/ts/components/header.tsx index 2787692c1..4d3a8685c 100644 --- a/packages/dev-tools-pages/ts/components/header.tsx +++ b/packages/dev-tools-pages/ts/components/header.tsx @@ -17,7 +17,7 @@ const Header: React.StatelessComponent<{}> = () => ( <Title>{title}</Title> </LogoMark> - <Link as="a" href="https://0xproject.com/"> + <Link as="a" href="https://0x.org/" target="_blank"> Built by 0x </Link> </Container> diff --git a/packages/dev-tools-pages/ts/components/hero.tsx b/packages/dev-tools-pages/ts/components/hero.tsx index cdcad6982..e2977f3f2 100644 --- a/packages/dev-tools-pages/ts/components/hero.tsx +++ b/packages/dev-tools-pages/ts/components/hero.tsx @@ -9,16 +9,16 @@ import { Beta } from './typography'; const Hero: React.StatelessComponent<ContextInterface> = ({ children }) => ( <ThemeContext.Consumer> - {({ subtitle, tagline }: ContextInterface) => ( + {({ subtitle, tagline, docLink }: ContextInterface) => ( <StyledHero> <HeroContainer> <Subtitle>{subtitle}</Subtitle> <Tagline as="p">{tagline}</Tagline> - <Button as="a" href="#" large={true}> + <Button as="a" href={docLink} target="_blank" large={true}> Read the Docs </Button> </HeroContainer> - {navigator.userAgent !== 'ReactSnap' ? children : null} + {children} </StyledHero> )} </ThemeContext.Consumer> diff --git a/packages/dev-tools-pages/ts/components/tabs.tsx b/packages/dev-tools-pages/ts/components/tabs.tsx index 1d26f2777..fa2145208 100644 --- a/packages/dev-tools-pages/ts/components/tabs.tsx +++ b/packages/dev-tools-pages/ts/components/tabs.tsx @@ -48,7 +48,9 @@ const Tabs: React.StatelessComponent<{}> = props => ( })} </StyledTabList> - {React.Children.map(props.children, child => <TabPanel>{child}</TabPanel>)} + {React.Children.map(props.children, child => ( + <TabPanel>{child}</TabPanel> + ))} </ReactTabs> </Breakout> ); diff --git a/packages/dev-tools-pages/ts/components/trace.tsx b/packages/dev-tools-pages/ts/components/trace.tsx index 108154648..81f6db0ab 100644 --- a/packages/dev-tools-pages/ts/components/trace.tsx +++ b/packages/dev-tools-pages/ts/components/trace.tsx @@ -25,7 +25,7 @@ const Trace: React.StatelessComponent<{}> = () => ( troublemaking line of code. The only hint you'll get is a generic error. </MainCopy> <Breakout> - <Code isLight={true}>Error: VM Exception while processing transaction: rever</Code> + <Code isLight={true}>Error: VM Exception while processing transaction: revert</Code> </Breakout> <List> @@ -44,8 +44,8 @@ const Trace: React.StatelessComponent<{}> = () => ( <Copy dark={true}> <Gamma as="h3">Time-consuming</Gamma> <p> - Working with a large code-base that contains hundreds of smart contracts, - finding the failing line of code quickly becomes a daunting task. + Working within a large code-base that contains many smart contracts, finding the + failing line of code quickly becomes a daunting task. </p> </Copy> <Icon as={TimeConsuming} /> @@ -78,8 +78,8 @@ const Trace: React.StatelessComponent<{}> = () => ( <Copy> <Gamma as="h3">Exact location</Gamma> <p> - It shows you the exact location of the specific code linen and where it was - called from. + It shows you the exact location of the offending line and where it was called + from. </p> </Copy> <Icon as={ExactLocation} /> @@ -90,8 +90,7 @@ const Trace: React.StatelessComponent<{}> = () => ( <Gamma as="h3">Time-saving</Gamma> <p> Turning "Your code failed somewhere, good luck debugging it" into "Your code - failed on line X of contract Y", it drastically improves the developer - experience. + failed on line X of contract Y", drastically improves the developer experience. </p> </Copy> <Icon as={TimeSaving} /> @@ -108,10 +107,7 @@ interface TraceProps { background?: string; } -const StyledSection = - styled.section < - TraceProps > - ` +const StyledSection = styled.section<TraceProps>` max-width: 90rem; margin: 0 auto; background: linear-gradient(to right, ${colors.black} 50%, ${props => props.background} 50%); @@ -138,10 +134,7 @@ const Wrapper = styled(Container)` `}; `; -const Block = - styled.div < - TraceProps > - ` +const Block = styled.div<TraceProps>` width: 50%; background: ${props => (props.background ? props.background : colors.black)}; color: ${props => (props.background ? 'inherit' : colors.white)}; @@ -200,10 +193,7 @@ const Item = styled.li` } `; -const Copy = - styled.div < - { dark: boolean } > - ` +const Copy = styled.div<{ dark: boolean }>` margin-right: 5.875rem; ${props => props.dark && diff --git a/packages/dev-tools-pages/ts/context/compiler.tsx b/packages/dev-tools-pages/ts/context/compiler.tsx index 177e265e5..e4642c826 100644 --- a/packages/dev-tools-pages/ts/context/compiler.tsx +++ b/packages/dev-tools-pages/ts/context/compiler.tsx @@ -5,6 +5,7 @@ import { ContextInterface } from './index'; export const context: ContextInterface = { title: 'sol-compiler', name: 'compiler', + docLink: 'https://0x.org/docs/sol-compiler', subtitle: 'Solidity compilation that just works', tagline: 'Seamlessly compile an entire solidity project and generate customisable artifacts', icon: Icon, diff --git a/packages/dev-tools-pages/ts/context/cov.tsx b/packages/dev-tools-pages/ts/context/coverage.tsx index 1ade45e9d..3e44b6ec2 100644 --- a/packages/dev-tools-pages/ts/context/cov.tsx +++ b/packages/dev-tools-pages/ts/context/coverage.tsx @@ -3,9 +3,10 @@ import Icon from 'ts/icons/logos/cov.svg'; import { ContextInterface } from './index'; export const context: ContextInterface = { - title: 'sol-cov', - name: 'cov', + title: 'sol-coverage', + name: 'coverage', subtitle: 'Solidity code coverage', + docLink: 'https://0x.org/docs/sol-coverage', tagline: 'Measure Solidity code coverage', icon: Icon, colors: { diff --git a/packages/dev-tools-pages/ts/context/index.tsx b/packages/dev-tools-pages/ts/context/index.tsx index 35c647ad6..97ccf5c16 100644 --- a/packages/dev-tools-pages/ts/context/index.tsx +++ b/packages/dev-tools-pages/ts/context/index.tsx @@ -3,6 +3,7 @@ import { createContext } from 'react'; interface ContextInterface { title?: string; name?: string; + docLink?: string; subtitle?: string; tagline?: string; icon?: React.ReactNode; diff --git a/packages/dev-tools-pages/ts/context/profiler.tsx b/packages/dev-tools-pages/ts/context/profiler.tsx index 5ccfa5b4c..e2ddcb230 100644 --- a/packages/dev-tools-pages/ts/context/profiler.tsx +++ b/packages/dev-tools-pages/ts/context/profiler.tsx @@ -5,6 +5,7 @@ import { ContextInterface } from './index'; export const context: ContextInterface = { title: 'sol-profiler', name: 'profiler', + docLink: 'https://0x.org/docs/sol-profiler', subtitle: 'Gas profiling for Solidity', tagline: "Implement data-guided optimizations by profiling your contract's gas usage", icon: Icon, diff --git a/packages/dev-tools-pages/ts/context/trace.tsx b/packages/dev-tools-pages/ts/context/trace.tsx index 9627cc0a4..3c19661f2 100644 --- a/packages/dev-tools-pages/ts/context/trace.tsx +++ b/packages/dev-tools-pages/ts/context/trace.tsx @@ -6,6 +6,7 @@ export const context: ContextInterface = { title: 'sol-trace', name: 'trace', subtitle: 'Human-readable stack traces', + docLink: 'https://0x.org/docs/sol-trace', tagline: 'Immediately locate Solidity errors and rapidly debug failed transactions', icon: Icon, colors: { diff --git a/packages/dev-tools-pages/ts/globalStyles.tsx b/packages/dev-tools-pages/ts/globalStyles.tsx index a77fb4eef..507497dd4 100644 --- a/packages/dev-tools-pages/ts/globalStyles.tsx +++ b/packages/dev-tools-pages/ts/globalStyles.tsx @@ -5,10 +5,7 @@ import styledNormalize from 'styled-normalize'; import { ContextInterface } from 'ts/context'; import { media } from 'ts/variables'; -const GlobalStyles = - createGlobalStyle < - ContextInterface > - ` +const GlobalStyles = createGlobalStyle<ContextInterface>` ${styledNormalize} ${hljsStyles} diff --git a/packages/dev-tools-pages/ts/pages/compiler.tsx b/packages/dev-tools-pages/ts/pages/compiler.tsx index 93a667562..407646add 100644 --- a/packages/dev-tools-pages/ts/pages/compiler.tsx +++ b/packages/dev-tools-pages/ts/pages/compiler.tsx @@ -6,6 +6,7 @@ import { context } from 'ts/context/compiler'; 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 { Compiler as CompilerComponent } from 'ts/components/compiler'; import { Content } from 'ts/components/content'; @@ -24,6 +25,9 @@ const Animation = Loadable({ }, }); +const SOLIDITY_INPUT_FORMAT_DOCS = + 'https://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description'; + const Compiler: React.StatelessComponent<{}> = () => ( <Base context={context}> <Hero> @@ -40,7 +44,7 @@ const Compiler: React.StatelessComponent<{}> = () => ( <ContentBlock title="Run"> <Breakout> - <Code>cd /your_project_dir && sol-compiler</Code> + <Code canCopy={true}>cd /your_project_dir && sol-compiler</Code> </Breakout> </ContentBlock> @@ -49,11 +53,11 @@ const Compiler: React.StatelessComponent<{}> = () => ( Configure via a <InlineCode>compiler.json</InlineCode> file. </p> <Breakout> - <Code>mkdir compiler.json</Code> + <Code canCopy={true}>mkdir compiler.json</Code> </Breakout> <p>Example of settings:</p> <Breakout> - <Code language="json"> + <Code language="json" canCopy={true}> {`{ "contractsDir": "contracts", "artifactsDir": "artifacts", @@ -74,15 +78,19 @@ const Compiler: React.StatelessComponent<{}> = () => ( <Content dark={true}> <ContentBlock main={true} title="Artifacts"> <Lead> - Sol compiler uses solidity standard JSON output format for the artifacts. This way, you can define - which parts of the artifact you need. + Sol compiler uses{' '} + <a href={SOLIDITY_INPUT_FORMAT_DOCS} target="_blank"> + Solidity standard JSON input format + </a>{' '} + to specify what to include in the generated artifacts. This way, you have complete flexibility on + what is included. </Lead> </ContentBlock> <ContentBlock title="Production"> <p> - Sol compiler uses solidity standard JSON output format for the artifacts. This way, you can define - which parts of the artifact you need. + In production, you want to optimize for a small bundle size, so your compiler.json config would + instruct sol-compiler to only output the contract ABI. </p> <Breakout> <Code isLight={true} language="json" isEtc={true}> @@ -109,8 +117,9 @@ const Compiler: React.StatelessComponent<{}> = () => ( </ContentBlock> <ContentBlock title="Development"> <p> - Sometimes you need to use some debuggers or other dev tools and you’ll need more info in the - artifact. + In development, you need to use profiler and other dev tools that require more information from the + artifact. To do this, you can specify that the artifact also contain the bytecode, deployed bytecode + and source maps. </p> <Breakout> <Code isLight={true} language="json" isEtc={true}> @@ -158,6 +167,9 @@ const Compiler: React.StatelessComponent<{}> = () => ( </Breakout> </ContentBlock> </Content> + <div style={{ paddingTop: '5rem' }}> + <CallToAction /> + </div> </Base> ); diff --git a/packages/dev-tools-pages/ts/pages/cov.tsx b/packages/dev-tools-pages/ts/pages/coverage.tsx index 85487248a..575891f3b 100644 --- a/packages/dev-tools-pages/ts/pages/cov.tsx +++ b/packages/dev-tools-pages/ts/pages/coverage.tsx @@ -2,10 +2,11 @@ import * as React from 'react'; import { hydrate, render } from 'react-dom'; import * as Loadable from 'react-loadable'; -import { context } from 'ts/context/cov'; +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'; @@ -25,7 +26,7 @@ const Animation = Loadable({ }, }); -const Cov: React.StatelessComponent<{}> = () => ( +const Coverage: React.StatelessComponent<{}> = () => ( <Base context={context}> <Hero> <Animation /> @@ -33,9 +34,9 @@ const Cov: React.StatelessComponent<{}> = () => ( <Intro> <IntroLead title="Measure your tests"> <p> - When it comes to writing smart contracts, testing is one of the most important steps of the process. - In order to quantify the robustness of your Solidity testing suite, you need to measure its code - coverage. + 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> @@ -69,29 +70,57 @@ const Cov: React.StatelessComponent<{}> = () => ( <ContentBlock title="Prerequisites"> <List> <ListItem> - Use <a href="#">ganache-cli</a> as a backing node. + 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="#">web3-provider-engine</a>. + 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>npm install @0x/sol-coverage --save</Code> + <Code canCopy={true}>npm install @0x/sol-coverage --save</Code> </Breakout> <p> - Sol-cov is a subprovider that needs to be prepended to your <a href="#">provider engine</a>. - Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-cov ships with - the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with <a href="#">Sol-compiler</a>{' '} + 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="#">Truffle framework</a>. You can also write your own and support any artifact format. + <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"> + <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 @@ -99,16 +128,16 @@ const artifactAdapter = new SolCompilerArtifactAdapter(artifactsDir, contractsDi </Code> </TabBlock> <TabBlock title="Truffle"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; const projectRoot = '.'; -const solcVersion = '0.4.24'; +const solcVersion = '0.5.0'; const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`} </Code> </TabBlock> <TabBlock title="Custom"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; class YourCustomArtifactsAdapter extends AbstractArtifactAdapter {...}; @@ -118,32 +147,33 @@ const artifactAdapter = new YourCustomArtifactsAdapter(...);`} </Tabs> <p> Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} - <InlineCode>RevertTraceSubprovider</InlineCode> and append it to our provider engine. + <InlineCode>CoverageSubprovider</InlineCode> and append it to our provider engine. </p> <Breakout> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; -import { RevertTraceSubprovider } from '@0x/sol-coverage'; +import { CoverageSubprovider } from '@0x/sol-coverage'; const defaultFromAddress = "..."; // Some ethereum address with test funds -const revertTraceSubprovider = new RevertTraceSubprovider(artifactAdapter, defaultFromAddress); +const coverageSubprovider = new CoverageSubprovider(artifactAdapter, defaultFromAddress); const providerEngine = new ProviderEngine(); -providerEngine.addProvider(revertTraceSubprovider); +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(<Cov />, root); + hydrate(<Coverage />, root); } else { - render(<Cov />, root); + render(<Coverage />, root); } diff --git a/packages/dev-tools-pages/ts/pages/profiler.tsx b/packages/dev-tools-pages/ts/pages/profiler.tsx index 16ac9088e..0bc4efa45 100644 --- a/packages/dev-tools-pages/ts/pages/profiler.tsx +++ b/packages/dev-tools-pages/ts/pages/profiler.tsx @@ -6,6 +6,7 @@ import { context } from 'ts/context/profiler'; 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'; @@ -66,29 +67,57 @@ const Profiler: React.StatelessComponent<{}> = () => ( <ContentBlock title="Prerequisites"> <List> <ListItem> - Use <a href="#">ganache-cli</a> as a backing node. + 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="#">web3-provider-engine</a>. + 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>npm install @0x/sol-trace --save</Code> + <Code canCopy={true}>npm install @0x/sol-trace --save</Code> </Breakout> <p> - Sol-trace is a subprovider that needs to be prepended to your <a href="#">provider engine</a>. - Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-trace ships + Sol-trace 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-trace ships with the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with{' '} - <a href="#">Sol-compiler</a> and <InlineCode>TruffleArtifactAdapter</InlineCode> for use with the{' '} - <a href="#">Truffle framework</a>. You can also write your own and support any artifact format. + <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"> + <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 @@ -96,16 +125,16 @@ const artifactAdapter = new SolCompilerArtifactAdapter(artifactsDir, contractsDi </Code> </TabBlock> <TabBlock title="Truffle"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; const projectRoot = '.'; -const solcVersion = '0.4.24'; +const solcVersion = '0.5.0'; const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`} </Code> </TabBlock> <TabBlock title="Custom"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; class YourCustomArtifactsAdapter extends AbstractArtifactAdapter {...}; @@ -115,25 +144,26 @@ const artifactAdapter = new YourCustomArtifactsAdapter(...);`} </Tabs> <p> Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} - <InlineCode>RevertTraceSubprovider</InlineCode> and append it to our provider engine. + <InlineCode>ProfilerSubprovider</InlineCode> and append it to our provider engine. </p> <Breakout> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; -import { RevertTraceSubprovider } from '@0x/sol-coverage'; +import { ProfilerSubprovider } from '@0x/sol-profiler'; const defaultFromAddress = "..."; // Some ethereum address with test funds -const revertTraceSubprovider = new RevertTraceSubprovider(artifactAdapter, defaultFromAddress); +const profilerSubprovider = new ProfilerSubprovider(artifactAdapter, defaultFromAddress); const providerEngine = new ProviderEngine(); -providerEngine.addProvider(revertTraceSubprovider); +providerEngine.addProvider(profilerSubprovider); providerEngine.addProvider(new RpcSubprovider({rpcUrl: 'http://localhost:8545'})); providerEngine.start();`} </Code> </Breakout> </ContentBlock> </Content> + <CallToAction /> </Base> ); diff --git a/packages/dev-tools-pages/ts/pages/trace.tsx b/packages/dev-tools-pages/ts/pages/trace.tsx index cc34e0fbe..cd6180fb9 100644 --- a/packages/dev-tools-pages/ts/pages/trace.tsx +++ b/packages/dev-tools-pages/ts/pages/trace.tsx @@ -6,6 +6,7 @@ import { context } from 'ts/context/trace'; 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'; @@ -36,29 +37,57 @@ const Trace: React.StatelessComponent<{}> = () => ( <ContentBlock title="Prerequisites"> <List> <ListItem> - Use <a href="#">ganache-cli</a> as a backing node. + 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="#">web3-provider-engine</a>. + 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>npm install @0x/sol-trace --save</Code> + <Code canCopy={true}>npm install @0x/sol-trace --save</Code> </Breakout> <p> - Sol-trace is a subprovider that needs to be prepended to your <a href="#">provider engine</a>. - Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-trace ships + Sol-trace 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-trace ships with the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with{' '} - <a href="#">Sol-compiler</a> and <InlineCode>TruffleArtifactAdapter</InlineCode> for use with the{' '} - <a href="#">Truffle framework</a>. You can also write your own and support any artifact format. + <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"> + <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 @@ -66,16 +95,16 @@ const artifactAdapter = new SolCompilerArtifactAdapter(artifactsDir, contractsDi </Code> </TabBlock> <TabBlock title="Truffle"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; const projectRoot = '.'; -const solcVersion = '0.4.24'; +const solcVersion = '0.5.0'; const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`} </Code> </TabBlock> <TabBlock title="Custom"> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; class YourCustomArtifactsAdapter extends AbstractArtifactAdapter {...}; @@ -85,13 +114,13 @@ const artifactAdapter = new YourCustomArtifactsAdapter(...);`} </Tabs> <p> Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} - <InlineCode>RevertTraceSubprovider</InlineCode> and append it to our provider engine. + <InlineCode>revertTraceSubprovider</InlineCode> and append it to our provider engine. </p> <Breakout> - <Code language="javascript"> + <Code language="javascript" canCopy={true}> {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; -import { RevertTraceSubprovider } from '@0x/sol-coverage'; +import { RevertTraceSubprovider } from '@0x/sol-trace'; const defaultFromAddress = "..."; // Some ethereum address with test funds const revertTraceSubprovider = new RevertTraceSubprovider(artifactAdapter, defaultFromAddress); @@ -102,8 +131,10 @@ providerEngine.addProvider(new RpcSubprovider({rpcUrl: 'http://localhost:8545'}) providerEngine.start();`} </Code> </Breakout> + <p>Stack traces will now be printed whenever your contracts revert!</p> </ContentBlock> </Content> + <CallToAction /> </Base> ); |