aboutsummaryrefslogtreecommitdiffstats
path: root/packages/dev-tools-pages/ts/pages/Compiler.tsx
blob: 11c8c4a17133cfff6d68941bffb301c185ca19eb (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
import * as React from 'react';
import { render, hydrate } from 'react-dom';

import { Lead } from 'ts/components/Typography';
import context from 'ts/context/compiler';
import Base from 'ts/components/Base';
import Content from 'ts/components/Content';
import ContentBlock from 'ts/components/ContentBlock';
import Code from 'ts/components/Code';
import InlineCode from 'ts/components/InlineCode';
import CompilerComponent from 'ts/components/Compiler';
import Breakout from 'ts/components/Breakout';

function Compiler() {
    return (
        <Base context={context}>
            <CompilerComponent />
            <Content>
                <ContentBlock main title="Get started" />
                <ContentBlock title="Install">
                    <Breakout>
                        <Code copy>npm install @0x/sol-compiler --g</Code>
                    </Breakout>
                </ContentBlock>

                <ContentBlock title="Run">
                    <Breakout>
                        <Code>cd /your_project_dir && sol-compiler</Code>
                    </Breakout>
                </ContentBlock>

                <ContentBlock title="Configure">
                    <p>
                        Configure via a <InlineCode>compiler.json</InlineCode> file.
                    </p>
                    <Breakout>
                        <Code>mkdir compiler.json</Code>
                    </Breakout>
                    <p>Example of settings:</p>
                    <Breakout>
                        <Code language="json">
                            {`{
    "contractsDir": "contracts",
    "artifactsDir": "artifacts",
    "contracts": "*",
    "compilerSettings": {
        "optimizer": { "enabled": false },
        "outputSelection": {
            "*": {
                "*": ["abi", "evm.bytecode.object"]
            }
        }
    }
}`}
                        </Code>
                    </Breakout>
                </ContentBlock>
            </Content>
            <Content dark>
                <ContentBlock main 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.
                    </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.
                    </p>
                    <Breakout>
                        <Code light language="json" etc>
                            {`{
    "compilerSettings": {
        "outputSelection": {
            "*": {
                "*": ["abi"]
            }
        }
    }
}`}
                        </Code>
                    </Breakout>
                    <Breakout>
                        <Code light language="json" etc>
                            {`{
    "compilerOutput": {
        "abi": [...],
    },
}`}
                        </Code>
                    </Breakout>
                </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.
                    </p>
                    <Breakout>
                        <Code light language="json" etc>
                            {`{
    "compilerSettings": {
        "outputSelection": {
            "*": {
                "*": [
                    "abi",
                    "evm.bytecode.object",
                    "evm.bytecode.sourceMap",
                    "evm.deployedBytecode.object",
                    "evm.deployedBytecode.sourceMap"
                ]
            }
        }
    }
}`}
                        </Code>
                    </Breakout>

                    <Breakout>
                        <Code light language="json" etc>
                            {`{
    "compilerOutput": {
        "abi": [...],
        "evm": {
            "bytecode": {
                "object": "0xdeadbeef",
                "sourceMap": "26:480:..."
            },
            "deployedBytecode": {
                "object": "0xdeadbeef",
                "sourceMap": "26:480:0..."
            }
        }
    }
    "sources": {
        "Migrations.sol": {
            "id": 0
        }
    },
}`}
                        </Code>
                    </Breakout>
                </ContentBlock>
            </Content>
        </Base>
    );
}

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

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