From 50ded59c3ce1a201080a5c8281f18ac36291d4a3 Mon Sep 17 00:00:00 2001 From: Frederic Fortier Date: Thu, 11 Jan 2018 14:01:00 -0500 Subject: [PATCH] DOC: documented the marketplace structure --- marketplace/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 marketplace/README.md diff --git a/marketplace/README.md b/marketplace/README.md new file mode 100644 index 00000000..599d8112 --- /dev/null +++ b/marketplace/README.md @@ -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` \ No newline at end of file