DOC: documented the marketplace structure

This commit is contained in:
Frederic Fortier
2018-01-11 14:01:00 -05:00
parent 354e422be8
commit 50ded59c3c
+18
View File
@@ -0,0 +1,18 @@
This module contains smart contracts for the data marketplace.
It was generated with Truffle. Truffle can be used to compile and test
the smart contracts. It's being tested on a test blockhain using Ganache.
Steps to test:
* Download an run Ganache
* Ensure that your Ganache endpoint matches `truffle.js`
* In this `marketplace` folder:
* `truffle compile`
* `truffle test`
* `truffle migrate --reset`
* `truffle console`
* From the console: `Marketplace.deployed()`
* The deployed method displays info about the deployed smart contract
including its address. Copy/paste the address into
`catalyst/marketplace/marketplace.py`.
* Run the catalyst marketplace unit tests:
`tests/marketplace/test_marketplace.py`