Skip to content
This repository has been archived by the owner on Feb 18, 2020. It is now read-only.

Commit

Permalink
Add fitst steps guide
Browse files Browse the repository at this point in the history
  • Loading branch information
anxolin committed Jul 6, 2018
1 parent 6256e06 commit 07d9c98
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 11 deletions.
30 changes: 30 additions & 0 deletions source/dev-first-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Develop on top of DutchX
For folowing this, you should be familiar with:
* Basics about Ethereum network
* Truffle projects
* Node and NPM

## Create your new cool-app
The easiest way to get started is to create a new node project that depends on
the [dx-contracts](https://github.com/gnosis/dx-contracts/tree/master/contracts)
project.

**DutchX** publish a NPM package with:
* All the compiled contracts (ABI, meta info, addresses)
* Migration code (useful for `development`)
* Some scripts

So Just follow the steps and create your `cool-app` out of this example:
[https://github.com/gnosis/dx-example-use-contracts](https://github.com/gnosis/dx-example-use-contracts)

## Use the DutchX
TODO: use truffle contract, invoke add token pair, participate auction

## Use DutchX as a Price Oracle
TODO:

## Test Rinkeby
TODO:

## Go live - Mainnet
TODO:
2 changes: 0 additions & 2 deletions source/development-first-steps.md

This file was deleted.

15 changes: 10 additions & 5 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ compliant.

Learn more about DutchX
-----------------------
One place you can learn all about the mechanisms of the DutchX is in:
Some interesting links to learn all about the mechanisms of the DutchX are:

* https://ethresear.ch/t/dutchx-fully-decentralized-auction-based-exchange/2443
* https://blog.gnosis.pm/tagged/dutchx

.. toctree::
Expand All @@ -25,17 +26,21 @@ One place you can learn all about the mechanisms of the DutchX is in:
:maxdepth: 2
:caption: Guides:

First steps <development-first-steps>
First steps (devs) <dev-first-steps>
Add a token pair <add-token-pair>
Run your own bots <run-your-own-bots>


.. toctree::
:maxdepth: 2
:caption: Reference:

reference_api
reference_smart-contracts

smart-contracts_addresses
API Reference <https://dx.staging.gnosisdev.com/api>
Github: Smart Contracts <https://github.com/gnosis/dx-contracts>
Github: Seller Web <https://github.com/gnosis/dx-react>
Github: API, Bots, CLI, services <https://github.com/gnosis/dx-services>


You may be also interested on
-----------------------------
Expand Down
2 changes: 0 additions & 2 deletions source/reference_api.md

This file was deleted.

2 changes: 0 additions & 2 deletions source/reference_smart-contracts.md

This file was deleted.

22 changes: 22 additions & 0 deletions source/smart-contracts_addresses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Smart Contracts Addresses

## Rinkeby
* DutchExchange (proxy): [https://rinkeby.etherscan.io/address/0x4e69969d9270ff55fc7c5043b074d4e45f795587]()
* DutchExchange (master): [https://rinkeby.etherscan.io/address/0x9e5e05700045dc70fc42c125d4bd661c798d4ce9]()
* PriceOracleInterface: [https://rinkeby.etherscan.io/address/0xa6a644ef9da924b3ecea6cbfd137a825d1ff2a91]()
* Medianizer: [https://rinkeby.etherscan.io/address/0xbfff80b73f081cc159534d922712551c5ed8b3d3]()
* [https://developer.makerdao.com/feeds]()
* [https://makerdao.com/feeds]()
* TokenFRT: [https://rinkeby.etherscan.io/token/0x152af9ad40ccef2060cd14356647ee1773a43437]()
* TokenOWL (proxy): [https://rinkeby.etherscan.io/token/0xa7d1c04faf998f9161fc9f800a99a809b84cfc9d]()


## Mainnet
* DutchExchange (proxy): [https://etherscan.io/address/0xaf1745c0f8117384dfa5fff40f824057c70f2ed3]()
* DutchExchange (master): [https://etherscan.io/address/0x039fb002d21c1c5eeb400612aef3d64d49eb0d94]()
* PriceOracleInterface: [https://etherscan.io/address/0xff29b0b15a0a1da474bc9a132077153c53a2373b]()
* Medianizer: [https://etherscan.io/address/0x729D19f657BD0614b4985Cf1D82531c67569197B]()
* [https://developer.makerdao.com/feeds]()
* [https://makerdao.com/feeds]()
* TokenFRT: [https://etherscan.io/token/0xb9625381f086e7b8512e4825f6af1117e9c84d43]()
* TokenOWL (proxy): [https://etherscan.io/token/0x1a5f9352af8af974bfc03399e3767df6370d82e4]()

0 comments on commit 07d9c98

Please sign in to comment.