Merge branch 'develop'

Author: wanderingstan

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,8 +9,8 @@ First pull request? Read our [guide to contributing](http://docs.originprotocol.
 
 ### Description:
 
-Please explain the changes you made here:
+Please explain the changes in this PR:
 
-- A description of the problem you're trying to solve
-- An overview of the suggested solution
-- If the feature changes current behavior, reasons why your solution is better
+- Description of the problem being solved
+- Overview of the suggested solution
+- If the feature changes current behavior, reasons why this solution is better

.gitignore

@@ -1,2 +1,39 @@
-.idea
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# Truffle build artifacts
+# https://ethereum.stackexchange.com/questions/19486/storing-a-truffle-contract-interface-in-version-control
+/build
+
+# compiled output
+/dist
+
+# dependencies
+/node_modules
+
+# IDEs and editors
+.idea/
+/.idea
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+testem.log
+/typings
 .DS_Store

packages/origin.js/.npmignore renamed to .npmignore

@@ -0,0 +1,20 @@
+# Contributing to Origin.js
+
+Thanks for helping out! 👍
+
+Before you summit a PR, you'll want to make sure that:
+
+1. Any changes are tested.
+2. All tests pass. (See each package's readme for instructions on testing that package.) 
+3. The formatting is correct. Just run `npm run format` in a package folder.
+
+If this is a new feature, make sure you've discussed it with [our #engineering channel on Discord](https://www.originprotocol.com/discord).
+
+
+### Coding style: Javascript 
+
+We use [NPM style](https://docs.npmjs.com/misc/coding-style), as automated by the [prettier](https://prettier.io) tool. 2 space indents, no semi-semicolons.
+
+### Coding style: Solidity
+
+We use two space indents. Just copy the surrounding style and use your good judgement.

CONTRIBUTING.md

@@ -1,50 +1,173 @@
 ![origin_github_banner](https://user-images.githubusercontent.com/673455/37314301-f8db9a90-2618-11e8-8fee-b44f38febf38.png)
 
+![origin_npm_version](https://img.shields.io/npm/v/@originprotocol/origin.svg) ![origin_license](https://img.shields.io/npm/l/@originprotocol/origin.svg)
+
 # Origin Platform
 
-Origin Protocol is a library of javascript code and Ethereum smart contracts which allow anyone to create decentralized marketplaces, including for fractional usage. 
+Origin Protocol is a library of javascript code and Ethereum smart contracts which allow anyone to create decentralized marketplaces, including for fractional usage.
 
 Please refer to our [product brief](https://www.originprotocol.com/product-brief) and [technical whitepaper](https://www.originprotocol.com/whitepaper) for more detail.
 
- - [README for Javascript code](https://github.com/OriginProtocol/platform/tree/master/packages/origin.js)
- - [README for Ethereum contracts](https://github.com/OriginProtocol/platform/tree/master/packages/contracts)
+ - [README for Javascript code](#originjs-documentation)
 
 ## Follow our progress and get involved
 
 This repo is under active development. We welcome your participation!
 
 1. [Join our #engineering channel on Discord](http://www.originprotocol.com/discord).
 
-2. Listen in on our weekly engineering call on Google Hangouts. It happens every week and everyone is welcome to listen in and participate. [Join us on Google Hangouts](https://meet.google.com/pws-cgyd-tqp) at the following times:
+2. Listen in on our weekly engineering call on Google Hangouts. It happens every week and everyone is welcome to listen in and participate. [Join us on Google Hangouts](https://meet.google.com/pws-cgyd-tqp) on Wednesdays at 9pm GMT ([Add to Calendar](https://calendar.google.com/event?action=TEMPLATE&tmeid=MHAyNHI3N2hzMjk5b3V2bjhoM2Q1ZWVzY2pfMjAxODA0MTFUMjAwMDAwWiBqb3NoQG9yaWdpbnByb3RvY29sLmNvbQ&tmsrc=josh%40originprotocol.com&scp=ALL)):
 
 > | Pacific | Mountain | Central | Eastern | GMT |
 > |---------|----------|---------|---------|-----|
 > | Wed 1pm | Wed 2pm | Wed 3pm | Wed 4pm | Wed 9pm |
-  
+
 3. Catch up on our meeting notes & weekly sprint planning docs (feel free to add comments):
 - [Engineering meeting notes](https://docs.google.com/document/d/1aRcAk_rEjRgd1BppzxZJK9RXfDkbuwKKH8nPQk7FfaU/)
 - [Weekly sprint doc](https://docs.google.com/document/d/1qJ3sem38ED8oRI72JkeilcvIs82oDq5IT3fHKBrhZIM)
 
-# What we're building
-
-The main components of this repo are:
+4. Read our simple [contributing and style guide](CONTRIBUTING.md).
 
- - [Origin.js](/packages/origin.js/)
- - [Ethereum smart contracts](/packages/contracts/)
- - Origin DApp that's built on top of origin.js (basically our current demo-dapp reworked to use origin.js)
+# What we're building
 
-This library is an abstraction layer for developers who want to build DApps on Origin Protocol.
+This library is an abstraction layer for developers who want to build DApps on Origin Protocol, and is also used to build the [Origin Demo DApp](https://github.com/OriginProtocol/demo-dapp).
 
 The library will make it easy for sellers to do things like:
 
  - Create listings
  - Update listings
  - Delete listings
  - Validate listings
- 
+
 And buyers to:
- 
+
  - Browse listing
  - Create bookings
  - Update bookings
  - Cancel bookings
+
+ # origin.js Documentation
+
+ ## Introduction
+
+ Welcome to the origin.js documentation! origin.js is a Javascript library for interacting with the Origin protocol.
+
+ Using the library you can create new listings from your applications, purchase them, or update them from your own off-chain applications.
+
+ ### Warning
+ This is still an alpha version which will evolve significantly before the main net release.
+
+ ## Using origin.js in your project
+
+ ### Plain javascript
+
+ A browser-compatible plain javascript file `origin.js` is available in the "Releases" tab, and will soon be hosted on originprotocol.com. It can be generated locally via `npm build` and will be placed in `dist/origin.js`.
+
+ ## Install
+
+ ### NPM
+ ```
+ npm install @originprotocol/origin --save
+ ```
+
+ ### Yarn
+ ```
+ yarn add @originprotocol/origin
+ ```
+
+ ### Local
+
+1. Clone
+```
+git clone https://github.com/OriginProtocol/platform origin-platform && cd origin-platform
+```
+
+2. Setup (shortcut for `npm install && npm link`). Linking makes this available as a local npm package for local dapp development.
+ ```
+ npm run setup
+ ```
+
+3. Start the localblockchain and create the build. Code changes will trigger a live rebuild.
+ ```
+ npm start
+ ```
+
+ 4. To develop against a working dapp and UI, see [the instructions in our demo dapp](https://github.com/OriginProtocol/demo-dapp#developing-with-a-local-chain).
+
+ ## Import
+
+ ```
+ import Origin from '@originprotocol/origin'
+
+ let configOptions = {}
+
+ let { contractService, ipfsService, originService } = new Origin(configOptions)
+ ```
+
+ ## Configuration Options
+
+ Config options are passed into the Origin constructor at instantiation.
+
+ ```
+ let configOptions = {
+   option: 'value'
+ }
+ let origin = new Origin(configOptions)
+ ```
+
+ Valid options:
+ - `ipfsDomain`
+ - `ipfsApiPort`
+ - `ipfsGatewayPort`
+ - `ipfsGatewayProtocol`
+
+ ## IPFS
+
+ If you are running a local IPFS daemon then set the following config options ([see config options](#configuration-options)):
+
+ ```
+ {
+   ipfsDomain: '127.0.0.1',
+   ipfsApiPort: '5001',
+   ipfsGatewayPort: '8080',
+   ipfsGatewayProtocol: 'http'
+ }
+ ```
+
+ Configure your local IPFS daemon with the following settings to avoid CORS errors:
+
+ ```
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["localhost:*"]'
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["GET", "POST", "PUT"]'
+ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'
+ ```
+
+ ## Troubleshooting
+
+ ### Python 3
+
+ If you have Python 3 installed, you may see this error when installing dependencies:
+
+ ```
+ gyp ERR! stack Error: Python executable "/Users/aiham/.pyenv/shims/python" is v3.6.4, which is not supported by gyp.
+ ```
+
+ Resolve this by configuring npm to use Python 2 (where python2.7 is a binary accessible from your $PATH):
+
+ ```
+ npm config set python python2.7
+ ```
+
+ ## Tests
+
+ Browser tests are automatically served at `http://localhost:8081` when you run `npm start`.
+
+ Tests are automatically rerun when source or test code is changed.
+
+ Run a subset of tests using the `grep` query string parameter, for example: http://localhost:8081/?grep=IpfsService
+
+ We also have contract unit tests that are not run in the browser. These can be run with `npm run test:contracts` (you should *not* have the server running at this time, as these tests start their own local blockchain instance).
+
+ ## Documentation
+
+ Needed

README.md

@@ -1,9 +1,11 @@
-pragma solidity ^0.4.11;
+pragma solidity 0.4.21;
 
 /// @title Listing
 /// @dev An indiviual Origin Listing representing an offer for booking/purchase
 
 import "./Purchase.sol";
+import "./PurchaseLibrary.sol";
+
 
 contract Listing {
 
@@ -12,6 +14,7 @@ contract Listing {
    */
 
   event ListingPurchased(Purchase _purchaseContract);
+  event ListingChange();
 
     /*
     * Storage
@@ -25,6 +28,7 @@ contract Listing {
     bytes32 public ipfsHash;
     uint public price;
     uint public unitsAvailable;
+    uint public expiration;
     Purchase[] public purchases;
 
 
@@ -41,14 +45,15 @@ contract Listing {
       ipfsHash = _ipfsHash;
       price = _price;
       unitsAvailable = _unitsAvailable;
+      expiration = now + 60 days;
     }
 
   /*
     * Modifiers
     */
 
   modifier isSeller() {
-    require (msg.sender == owner);
+    require(msg.sender == owner);
     _;
   }
 
@@ -64,10 +69,13 @@ contract Listing {
     payable
   {
     // Ensure that this is not trying to purchase more than is available.
-    require (_unitsToBuy <= unitsAvailable);
+    require(_unitsToBuy <= unitsAvailable);
+
+    // Ensure that we are not past the expiration
+    require(now < expiration);
 
     // Create purchase contract
-    Purchase purchaseContract = new Purchase(this, msg.sender);
+    Purchase purchaseContract = PurchaseLibrary.newPurchase(this, msg.sender);
 
     // Count units as sold
     unitsAvailable -= _unitsToBuy;
@@ -77,7 +85,8 @@ contract Listing {
     // TODO STAN: How to call function *AND* transfer value??
     purchaseContract.pay.value(msg.value)();
 
-    ListingPurchased(purchaseContract);
+    emit ListingPurchased(purchaseContract);
+    emit ListingChange();
   }
 
   /// @dev close(): Allows a seller to close the listing from further purchases
@@ -86,6 +95,7 @@ contract Listing {
     isSeller
   {
     unitsAvailable = 0;
+    emit ListingChange();
   }
 
   /// @dev purchasesLength(): Return number of listings