forked from ProjectWyvern/wyvern-ethereum
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
61 lines (61 loc) · 10.6 KB
/
index.html
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
<!DOCTYPE html>
<html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>wyvern-ethereum</title><link href="//cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.2.4/semantic.min.css" rel="stylesheet"/><link href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAAOVBMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAABMaXEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABlVggfAAAAE3RSTlPkZE7emXPXAMzHihi+QAwqs6mhB70WSgAAAQFJREFUOMuFk1mSwyAMRAUWhH3J/Q8bFikxNp7pn7hKL12qbgGvfwS/T6Utqfgd4DUYAt5qBziAgwwQ8x3I0DQtEFHdgdqBYVEbgPEKRBhqe4Y+R5cugJ0AtA0HgHIFBM1BT4Nm4RfAHCzFiguAhqQekvQ0D+kpajUB8dhFCn1e/ihLdIAWc3nXRTEGKXX+WIFoDP2xfq3We0A3f+WyzAnIM7tU+jZyA5y3/QVyA3xYI70BjkNfy5IsoVlurZtKxsC9g1zLonm1mi/nsoMkA8unFa9luWlgyaLecogdGFd/dMBvHg5iGYBpc7eJOuObXt4BOm0fbyDAwPZtvrxgnS/3AwT9GsisQa84AAAAAElFTkSuQmCC" rel="icon"/><style>@import url(https://fonts.googleapis.com/css?family=Roboto:400,700|Roboto+Mono);@media only screen and (max-width:767px){[class*="computer only"]:not(.mobile),[class*="large screen only"]:not(.mobile),[class*="mobile hidden"],[class*="or lower hidden"],[class*="tablet only"]:not(.mobile),[class*="widescreen only"]:not(.mobile){display:none!important}}@media only screen and (min-width:768px) and (max-width:991px){[class*="computer only"]:not(.tablet),[class*="large screen only"]:not(.tablet),[class*="mobile only"]:not(.tablet),[class*="or lower hidden"]:not(.mobile),[class*="tablet hidden"],[class*="widescreen only"]:not(.tablet){display:none!important}}@media only screen and (min-width:992px) and (max-width:1199px){[class*="computer hidden"],[class*="large screen only"]:not(.computer),[class*="mobile only"]:not(.computer),[class*="or lower hidden"]:not(.tablet):not(.mobile),[class*="tablet only"]:not(.computer),[class*="widescreen only"]:not(.computer){display:none!important}}@media only screen and (min-width:1200px) and (max-width:1919px){[class*="computer only"]:not([class*="large screen"]),[class*="large screen hidden"],[class*="mobile only"]:not([class*="large screen"]),[class*="or lower hidden"]:not(.computer):not(.tablet):not(.mobile),[class*="tablet only"]:not([class*="large screen"]),[class*="widescreen only"]:not([class*="large screen"]){display:none!important}}@media only screen and (min-width:1920px){[class*="computer only"]:not([class*=widescreen]),[class*="large screen only"]:not([class*=widescreen]),[class*="mobile only"]:not([class*=widescreen]),[class*="tablet only"]:not([class*=widescreen]),[class*="widescreen hidden"],[class*="widescreen or lower hidden"]{display:none!important}}.ui.header,.ui.menu,body,h1,h2,h3,h4,h5{font-family:Roboto,sans-serif}pre.wrap{white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}code{padding:0 .3em}code,pre{font-family:Roboto Mono,monospace;border:1px solid rgba(0,0,0,.05);background:rgba(0,0,0,.01)}code>code,pre>code{border:none;background:none}pre{padding:1em}.vertical.menu .item{overflow:hidden;text-overflow:ellipsis}.vertical.menu .item.active{overflow:visible}.pusher{display:flex;min-height:100vh;flex-direction:column}.pusher>.container:not(.footer){flex:1}.pusher>.footer{height:auto;margin-top:2em}.header code.signature{font-size:.6em}.ui.method-input{max-width:6em;overflow:hidden;text-overflow:ellipsis;text-align:right}.ui.method-input input{background:hsla(0,0%,100%,.7)}.hljs{display:block;overflow-x:auto;padding:.5em;color:#383a42;background:#fafafa}.hljs-comment,.hljs-quote{color:#a0a1a7;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e45649}.hljs-literal{color:#0184bb}.hljs-addition,.hljs-attribute,.hljs-meta-string,.hljs-regexp,.hljs-string{color:#50a14f}.hljs-built_in,.hljs-class .hljs-title{color:#c18401}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#4078f2}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}</style></head><body><div id="react-mount"><div style="padding-top:60px;" class="pusher" data-reactroot="" data-reactid="1" data-react-checksum="1872352592"><div class="ui top fixed inverted menu" data-reactid="2"><div class="ui container" data-reactid="3"><a class="header item" href="/" data-reactid="4"><!-- react-text: 5 -->wyvern-ethereum<!-- /react-text --><div class="ui grey label" data-reactid="6">1.0.0</div></a><div class="item mobile hidden" data-reactid="7">Wyvern Ethereum Contracts</div><div class="right menu" data-reactid="8"><a class="item" href="/docs/ArrayUtils/" data-reactid="9">Contracts</a><a target="_blank" href="https://github.com/ProjectWyvern/wyvern-ethereum#readme" class="item" data-reactid="10"><i class="home icon" data-reactid="11"></i></a></div></div></div><div class="ui container" data-reactid="12"><div class="markdown" data-reactid="13"><h1 data-reactid="14"></h1><div data-reactid="15"><p><img src="https://media.githubusercontent.com/media/ProjectWyvern/wyvern-branding/master/logo/logo-square-red-transparent-200x200.png?raw=true" alt="Project Wyvern Logo" title="Project Wyvern Logo"></p>
<h2>Project Wyvern Ethereum Smart Contracts</h2>
<p><a href="https://opensource.org/licenses/MIT"><img src="https://badges.frapsoft.com/os/mit/mit.svg?v=102" alt="https://badges.frapsoft.com/os/mit/mit.svg?v=102"></a> <a href="https://travis-ci.org/ProjectWyvern/wyvern-ethereum"><img src="https://travis-ci.org/ProjectWyvern/wyvern-ethereum.svg?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/github/ProjectWyvern/wyvern-ethereum?branch=master"><img src="https://coveralls.io/repos/github/ProjectWyvern/wyvern-ethereum/badge.svg?branch=master" alt="Coverage Status"></a></p>
<h3>Synopsis</h3>
<p><em>Autonomously governed decentralized digital asset exchange.</em></p>
<p>These are the Ethereum smart contracts for the Wyvern Protocol, the Wyvern ERC20 token (WYV), and the Wyvern DAO. For general information on the Wyvern project, please see <a href="https://projectwyvern.com">the website</a>.</p>
<h3>Deployed Contracts</h3>
<p><em>Please note: correct deployed contract addresses will always be in config.json. If you wish to import this repository directly, please use that file. The addresses in Truffle build output are not necessarily accurate.</em></p>
<h4>Mainnet</h4>
<p><a href="https://etherscan.io/address/wyvernexchange.eth">Wyvern Exchange</a></p>
<p><a href="https://etherscan.io/address/wyvernproxyregistry.eth">Wyvern Proxy Registry</a></p>
<p><a href="https://etherscan.io/address/wyverntoken.eth">Wyvern Token</a></p>
<p><a href="https://etherscan.io/address/wyverndao.eth">Wyvern DAO</a></p>
<h4>Rinkeby Testnet</h4>
<p><a href="https://rinkeby.etherscan.io/address/0xdca1fbe9f9469613aa2101b5e797226a9b586297">Wyvern Exchange</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0x90b0c4d26520be6a941954d565f90ecf2991d8a7">Wyvern Atomicizer</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0x32f51cefe7d1cac49334b7267da6ae7a127526da">Wyvern DAO Proxy</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0xb89f6ac677a7530d9d6649d299350be90a50ad1e">Wyvern Token Transfer Proxy</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0xeceaa7453a77bfe339b25d9d9e91009cde71c768">Wyvern Proxy Registry</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0xd1be358dab323802a3c469b0787476fdcb8af5d6">Wyvern Token</a></p>
<p><a href="https://rinkeby.etherscan.io/address/0x1b4c767502d01deee83af491c946b469e0620e30">Wyvern DAO</a></p>
<h3>Development Information</h3>
<h4>Setup</h4>
<p><a href="https://nodejs.org/en/">Node >= v6.9.1</a> and <a href="https://yarnpkg.com/en/">Yarn</a> required.</p>
<p>Before any development, install the required NPM dependencies:</p>
<pre><code class="language-bash">yarn
</code></pre>
<h4>Testing</h4>
<p>Start Ethereum’s testrpc tool to provide a Web3 interface (leave this running):</p>
<pre><code class="language-bash">yarn testrpc
</code></pre>
<p>Compile the latest smart contracts:</p>
<pre><code class="language-bash">yarn compile
</code></pre>
<p>Run the testsuite against the simulated network:</p>
<pre><code class="language-bash">yarn <span class="hljs-built_in">test</span>
</code></pre>
<p>Make sure to lint the Solidity files once you’re done:</p>
<pre><code class="language-bash">yarn lint
</code></pre>
<h4>Generating Documentation</h4>
<p>Install the dependencies:</p>
<pre><code class="language-bash"><span class="hljs-built_in">cd</span> doxity
yarn
<span class="hljs-built_in">cd</span> ..
</code></pre>
<p>Autogenerate documentation from Ethereum Natspec using <a href="https://github.com/DigixGlobal/doxity">Doxity</a>:</p>
<pre><code class="language-bash">yarn doc
</code></pre>
<p>Final output will be written to <a href="docs">docs</a>, which will be automatically published on push to GitHub Pages at <a href="https://docs.projectwyvern.com">docs.projectwyvern.com</a>.</p>
<h4>Misc</h4>
<p>Run automated smart contract analysis (requires <a href="https://github.com/melonproject/oyente">Oyente</a> and <a href="https://github.com/ConsenSys/mythril">Mythril</a>):</p>
<pre><code class="language-bash">yarn analyze
</code></pre>
<p>Flatten contract source (for e.g. Etherscan verification, requires <a href="https://github.com/BlockCatIO/solidity-flattener">solidity-flattener</a> to be installed):</p>
<pre><code class="language-bash">yarn flatten
</code></pre>
<h4>Contributing</h4>
<p>Contributions welcome! Please use GitHub issues for suggestions/concerns - if you prefer to express your intentions in code, feel free to submit a pull request.</p>
</div></div></div><div class="ui container footer" data-reactid="16"><div class="ui small top attached compact secondary segment" data-reactid="17"><div class="ui stackable grid" data-reactid="18"><div class="row" data-reactid="19"><div class="six wide column" data-reactid="20"><b data-reactid="21"><!-- react-text: 22 -->© <!-- /react-text --><!-- react-text: 23 -->Project Wyvern Developers<!-- /react-text --></b><!-- react-text: 24 --> - <!-- /react-text --><!-- react-text: 25 -->MIT<!-- /react-text --><!-- react-text: 26 -->, <!-- /react-text --><!-- react-text: 27 -->2018<!-- /react-text --></div><div class="right aligned ten wide column" data-reactid="28"><!-- react-text: 29 -->Docs built using <!-- /react-text --><b data-reactid="30"><!-- react-text: 31 -->Solidity <!-- /react-text --></b><!-- react-text: 32 --> on <!-- /react-text --><b data-reactid="33">3/3/2018</b></div></div></div></div></div></div></div><script src="/bundle.js?t=1520134546773"></script></body></html>