140 lines
5.8 KiB
TypeScript
140 lines
5.8 KiB
TypeScript
import * as React from 'react';
|
|
import { render, hydrate } from 'react-dom';
|
|
import * as Loadable from 'react-loadable';
|
|
|
|
import context from 'ts/context/profiler';
|
|
import Base from 'ts/components/Base';
|
|
import Content from 'ts/components/Content';
|
|
import ContentBlock from 'ts/components/ContentBlock';
|
|
import Breakout from 'ts/components/Breakout';
|
|
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 { Intro, IntroLead, IntroAside } from 'ts/components/Intro';
|
|
import Hero from 'ts/components/Hero';
|
|
|
|
const Animation = Loadable({
|
|
loader: () => System.import(/* webpackChunkName: 'profiler-animation' */ 'ts/components/Animations/Profiler'),
|
|
loading: () => <div />,
|
|
delay: 1000,
|
|
});
|
|
|
|
function Profiler() {
|
|
return (
|
|
<Base context={context}>
|
|
<Hero>
|
|
<Animation />
|
|
</Hero>
|
|
<Intro>
|
|
<IntroLead title="Outline gas usage">
|
|
<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>
|
|
</IntroLead>
|
|
<IntroAside>
|
|
<Code language="javascript" diff gutterLength={6} gutter={[15, 15, undefined, 21747, 20303, 1435]}>
|
|
{`+function() public payable {
|
|
+ deposit();
|
|
}
|
|
+function deposit() public payabble {
|
|
+ balanceOf[msg.sender] += msg.value;
|
|
+ Deposit(msg.sender, msg.value);
|
|
}
|
|
-function withdraw(uint wad) public {
|
|
- require(balanceOf[msg.sender] >= wad);
|
|
- balanceOf[msg.sender] -= wad;
|
|
- msg.sender.transfer(wad);
|
|
- Withdrawal(msg.sender, wad);
|
|
}`}
|
|
</Code>
|
|
</IntroAside>
|
|
</Intro>
|
|
<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(<Profiler />, root);
|
|
} else {
|
|
render(<Profiler />, root);
|
|
}
|