packages/dev-tools-pages/ts/pages/Profiler.tsx


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

import * as React from 'react';

import context from 'ts/context/profiler';
import Base from './Base';
import Container from 'ts/components/Container';
import Main from 'ts/components/Main';
import ContentBlock from 'ts/components/ContentBlock';
import { Tabs, TabBlock } from 'ts/components/Tabs';
import Code from 'ts/components/Code';
import InlineCode from 'ts/components/InlineCode';
import List from 'ts/components/List';
import Intro from 'ts/components/Intro';

function Profiler(props: any) {
    return (
        <Base context={context}>
            <Container>
                <Intro title="ra">
                    <p>
                        Sol-profiler gathers line-by-line gas usage for any transaction submitted through your provider.
                        This will help you find unexpected inefficiencies in parts of your smart contract, and take a
                        data-driven approach to optimizing it.
                    </p>
                </Intro>
                <Main>
                    <ContentBlock title="Required steps">
                        <List items={['Step 1', 'Step 2']} />
                    </ContentBlock>
                    <ContentBlock title="Prerequisites">
                        <Code>npm install @0x/sol-trace --save</Code>
                        <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 with the{' '}
                            <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with Sol-compiler and{' '}
                            <InlineCode>TruffleArtifactAdapter</InlineCode> for use with the Truffle framework. You can
                            also write your own and support any artifact format.
                        </p>
                    </ContentBlock>

                    <ContentBlock title="Installation">
                        <Tabs>
                            <TabBlock title="Sol-compiler">
                                <Code language="js">
                                    {`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">Truffle</TabBlock>
                            <TabBlock title="Custom">Custom</TabBlock>
                        </Tabs>
                    </ContentBlock>
                </Main>
            </Container>
        </Base>
    );
}

export default Profiler;