Merge pull request #14 from singnet/job

Refactor Job contract logic

Author: tiero

README.md

@@ -28,4 +28,9 @@ or
 
 ```bash
 truffle test
-```
+```
+
+## Flattening
+
+`solidity_flattener contracts/Contract.sol --solc-paths=zeppelin-solidity=$(pwd)/node_modules/zeppelin-solidity/ --output contract.sol`
+

contracts/agent/Agent.sol

@@ -6,7 +6,6 @@ import "zeppelin-solidity/contracts/ownership/Ownable.sol";
 contract Agent is AgentInterface, Ownable {
 
     bytes[] public packets;
-    MarketJobInterface public job;
 
     function sendPacket(address target, bytes packet) external onlyOwner {
         Agent(target).appendPacket(packet);
@@ -21,8 +20,4 @@ contract Agent is AgentInterface, Ownable {
         return packets[id];
     }
 
-    function setJob(MarketJob _job) external returns (address) {
-        job = _job;
-    }
-
 }

contracts/agent/AgentInterface.sol

@@ -1,12 +1,10 @@
 pragma solidity ^0.4.18;
 
-import "../market/MarketJob.sol";
 
 contract AgentInterface {
 
     function sendPacket(address target, bytes packet) external;
     function appendPacket(bytes packet) external;
     function getPacket(uint id) external constant returns (bytes);
-    function setJob(MarketJob _job) external returns (address);
 
 }

contracts/market/Escrow.sol

@@ -1,27 +1,98 @@
-pragma solidity ^0.4.11;
+pragma solidity ^0.4.18;
 
-import "zeppelin-solidity/contracts/ownership/Ownable.sol";
+import "./Job.sol";
+import "zeppelin-solidity/contracts/token/ERC20.sol";
 
-contract Escrow is Ownable {
 
+contract Escrow is Job {
+    /**
+     * @dev Kovan token.
+     * https://kovan.etherscan.io/token/0x3b226ff6aad7851d3263e53cb7688d13a07f6e81#readContract
+     */  
+    ERC20 public token;
 
-    address public beneficiary;
+    /**
+     * @dev Fund  Timelock in milliseconds
+     */
+    uint256 public timelock;
+    
+    /**
+     * @dev Deposited event
+     */
+    event Deposited(address payer, uint256 amount);
 
-    event Deposited(address indexed from, uint amount);
+     /**
+      * @dev Deposited event
+      */
+    event Withdrew(address payee, uint256 amount);
 
-    function Escrow(address _beneficiary) {
-        beneficiary = _beneficiary;
+    /**
+      * @dev Escrow constructor.
+      * @param _payer An agent who pays the job.
+      * @param _payee An agent to whom the job is paid.
+      * @param _timelock how many seconds after end should be the window for rejections   
+      * @param _validator who should check if rejected
+      * @param _reward reward for validator
+      */
+    function Escrow(
+        address _token,
+        address _payer, 
+        address _payee,
+        uint256 _timelock,
+        address _validator,
+        uint256 _reward ) public
+    {
+        token = ERC20(_token);
+        payer = _payer;
+        payee = _payee;
+
+        timelock = _timelock;
+        //Reward for the validator in case of dispute
+        validator = _validator;
+        reward = _reward;
+
+        //Who actually should deliver the job, capable of setResult and close the job
+        //Beaware that who can withdraw money is still the payee, not the provider
+        provider = payee;
+
+    }
+
+    /**
+      * @dev Deposit function.
+      * @param _amount Token amount to fill the price
+      * @param _descriptor bytes hash that represent the input for the job      
+      */
+    function deposit(uint256 _amount, bytes32 _descriptor) public {
+        require(msg.sender == payer);
+        require(token.transferFrom(msg.sender, this, _amount));
+        Deposited(msg.sender, _amount);
+        
+        descriptor = _descriptor;
+        price = _amount;
+        start = now;
+
+        Started(payer, payee, descriptor, address(this));
     }
 
-    function () payable {
-        if (msg.value <= 0) {
-            return;
-        }
+     /**
+      * @dev withdraw all funds from escrow 
+      */
+    function withdraw() public {
+        require(msg.sender == payee);
+        require(timelockExpired());
+        require(!isRejected); 
 
-        Deposited(msg.sender, msg.value);
+        uint256 balance = token.balanceOf(this);
+        require (balance > 0);
+
+        require(token.transfer(msg.sender, balance));
+        Withdrew(msg.sender, balance);
     }
 
-    function releaseFunds() onlyOwner {
-        beneficiary.transfer(this.balance);
+    function timelockExpired() internal constant returns(bool) {
+        bool isExpired = (end + timelock) <= block.timestamp;
+        return isCompleted && isExpired ;
     }
-}
+
+    
+}

contracts/market/Job.sol

@@ -1,39 +1,61 @@
 pragma solidity ^0.4.18;
 
-contract Job {
-    uint256 public status = 0;
-    bytes32 public jobDescriptor;
-    bytes32 public jobResult;
+import "./JobValidator.sol";
+/**
+ * @title The wrapped Job contract 
+ */
+contract Job is JobValidator {
+
+    /**
+     * @dev Determines if job is completed
+     */
+    bool public isCompleted = false; 
+
+    /**
+     * @dev Who can set the result
+     */
+    address public provider;
+    
+    /**
+     * @dev Price in AGI for the exection of the job
+     * (10**8 cogs === 1 AGI)
+     */
+    uint256 public price;
+
+    /**
+     * @dev Started event
+     */
+    event Started(address indexed payer, address indexed payee, bytes32 descriptor, address job);
+
+    /**
+     * @dev Set result of this Job
+     * @param _result Result data hash
+     */
+    function setResult(bytes32 _result) public returns (bool) {
+        require(msg.sender == provider);
+        require(descriptor.length > 0);
 
-    uint256 public start;
-    uint256 public end;
-
-    address public payer;
-    address public payee;
-
-    event JobStarted(address indexed payer, address indexed payee, bytes32 jobDescriptor, address jobAddress);
-    event JobCompleted(bytes32 jobResult, address jobAddress);
+        end = now;
+ 
+        Result(_result);
+        result = _result;
 
-    function setJobStarted(address _payer, address _payee, bytes32 _jobDescriptor) public {
-        require(status < 1);
-        payer = _payer;
-        payee = _payee;
-        jobDescriptor = _jobDescriptor;
-        status = 1;
-        start = now;
+        Completed();
+        isCompleted = true;
 
-        JobStarted(payer, payee, jobDescriptor, address(this));
+        return true;
     }
 
-    function setJobCompleted(bytes32 _jobResult) public {
-        require(msg.sender == payee);
-        require(status < 2);        
-        status = 2;
-        jobResult = _jobResult;
-        end = now;
+    /**
+     * @dev The payee can change the provider address
+     * @param _provider New provider
+     */
+     function setProvider(address _provider) public returns(bool) {
+         require(msg.sender == payee);
+         provider = _provider;
+         return true;
+     }
 
-        JobCompleted(jobResult, address(this));
 
-    }
 
 }

contracts/market/JobStandard.sol

@@ -0,0 +1,42 @@
+pragma solidity ^0.4.18;
+
+/**
+ * @title The Job Interface contract 
+ */
+
+contract JobStandard {
+    /** 
+     * @dev Starting hash of the job
+     */
+    bytes32 public descriptor;
+
+    /** 
+     * @dev Result hash of the job
+     */
+    bytes32 public result;
+
+    /** 
+     * @dev Start time timestamp 
+     */
+    uint256 public start;
+
+    /** 
+     * @dev End time timestamp 
+     */
+    uint256 public end;
+
+    /**
+     * @dev An agent who pays the job.
+     */
+    address public payer;
+
+    /**
+     * @dev An agent to whom the job is paid.
+     */
+    address public payee;
+
+    /**
+     * @dev Broadcast new hash as job result.
+     */
+    event Result(bytes32 result); 
+}

contracts/market/JobValidator.sol

@@ -0,0 +1,61 @@
+pragma solidity ^0.4.18;
+
+import "./JobStandard.sol";
+
+/**
+ * @title The Job Validator contract 
+ */
+
+contract JobValidator is JobStandard {
+
+    /**
+     * @dev Reward for validator in AGI.
+     */
+    address public validator; 
+
+    /**
+     * @dev rejection status
+     */
+    bool public isRejected = false; 
+    
+    /**
+     * @dev Reward for validator in AGI.
+     */
+    uint256 public reward; 
+
+    /**
+     * @dev Completed event to notice the validators pool
+     */
+    event Completed();
+
+    /**
+     * @dev Approved event to notice the parties
+     */
+    event Accepted();
+
+    /**
+     * @dev Rejected event to notice the parties
+     */
+    event Rejected();
+
+
+    /**
+     * @dev Confirm job result
+     * Is optional, even if not called by the payer at the expiration time 
+     * funds will be available for to payee
+     */
+    function accept() public {
+        require(msg.sender == payer);
+        Accepted();
+    }
+
+    /**
+     * @dev Reject job result
+     */
+    function reject() public {
+        require(msg.sender == payer);
+        isRejected = true;
+        Rejected();
+    }
+
+}