aboutsummaryrefslogtreecommitdiffstats
path: root/packages/dev-tools-pages/ts/pages/Trace.tsx
blob: 1a09d7c3a7a4dba33496376fba91e178cc5680b3 (plain) (blame)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
import * as React from 'react';
import { render, hydrate } from 'react-dom';
import * as Loadable from 'react-loadable';

import context from 'ts/context/trace';
import Base from 'ts/components/Base';
import Content from 'ts/components/Content';
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, ListItem } from 'ts/components/List';
import TraceComponent from 'ts/components/Trace';
import Breakout from 'ts/components/Breakout';
import Hero from 'ts/components/Hero';

const Animation = Loadable({
    loader: () => System.import(/* webpackChunkName: 'trace-animation' */ 'ts/components/Animations/Trace'),
    loading: () => <div />,
    delay: 1000,
});

function Trace() {
    return (
        <Base context={context}>
            <Hero>
                <Animation />
            </Hero>
            <TraceComponent />
            <Content>
                <ContentBlock main title="Get started" />
                <ContentBlock title="Prerequisites">
                    <List>
                        <ListItem>
                            Use <a href="#">ganache-cli</a> as a backing node.
                        </ListItem>
                        <ListItem>
                            Understand and use <a href="#">web3-provider-engine</a>.
                        </ListItem>
                    </List>
                </ContentBlock>
                <ContentBlock title="Installation">
                    <Breakout>
                        <Code>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 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.
                    </p>

                    <Tabs>
                        <TabBlock title="Sol-compiler">
                            <Code language="javascript">
                                {`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">
                                {`import { TruffleArtifactAdapter } from '@0x/sol-trace';

const projectRoot = '.';
const solcVersion = '0.4.24';
const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`}
                            </Code>
                        </TabBlock>
                        <TabBlock title="Custom">
                            <Code language="javascript">
                                {`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>RevertTraceSubprovider</InlineCode> and append it to our provider engine.
                    </p>

                    <Breakout>
                        <Code language="javascript">
                            {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine';
import { RevertTraceSubprovider } from '@0x/sol-cov';

const defaultFromAddress = "..."; // Some ethereum address with test funds
const revertTraceSubprovider = new RevertTraceSubprovider(artifactAdapter, defaultFromAddress);

const providerEngine = new ProviderEngine();
providerEngine.addProvider(revertTraceSubprovider);
providerEngine.addProvider(new RpcSubprovider({rpcUrl: 'http://localhost:8545'}));
providerEngine.start();`}
                        </Code>
                    </Breakout>
                </ContentBlock>
            </Content>
        </Base>
    );
}

const root = document.getElementById('app');

if (root.hasChildNodes()) {
    hydrate(<Trace />, root);
} else {
    render(<Trace />, root);
}