Merge pull request #11 from Bubblyworld/master

Add sequence number to trades

Author: neilgarb

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "luno/luno-php",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "type": "library",
   "description": "PHP SDK for the Luno API",
   "keywords": ["luno", "bitcoin", "ethereum"],

src/Luno/AbstractClient.php

@@ -11,7 +11,7 @@
  */
 abstract class AbstractClient
 {
-  private static $version = "0.0.3";
+  private static $version = "0.0.4";
   private static $defaultBaseURL = 'https://api.mybitx.com/';
   private static $defaultTimeoutSeconds = 10.0;
 

src/Luno/Client.php

@@ -345,7 +345,8 @@ public function ListTransactions(Request\ListTransactions $req): Response\ListTr
    * ListUserTrades makes a call to GET /api/1/listtrades.
    *
    * Returns a list of your recent trades for a given pair, sorted by oldest
-   * first.
+   * first. If <code>before</code> is specified, then the trades are returned
+   * sorted by most-recent first.
    * 
    * <code>type</code> in the response indicates the type of order that you placed
    * in order to participate in the trade. Possible types: <code>BID</code>,
@@ -435,7 +436,7 @@ public function PostMarketOrder(Request\PostMarketOrder $req): Response\PostMark
    * If the email address is not associated with an existing Luno account, an
    * invitation to create an account and claim the funds will be sent.
    * 
-   * Warning! Digital currency transactions are irreversible. Please ensure your
+   * Warning! Cryptocurrency transactions are irreversible. Please ensure your
    * program has been thoroughly tested before using this call.
    * 
    * Permissions required: <code>Perm_W_Send</code>

src/Luno/Request/ListUserTrades.php

@@ -9,6 +9,23 @@ class ListUserTrades extends AbstractRequest
    */
   protected $pair;
 
+  /**
+   * Filter to trades from (including) this sequence number.
+   * Default behaviour is not to include this filter.
+   */
+  protected $after_seq;
+
+  /**
+   * Filter to trades before this timestamp.
+   */
+  protected $before;
+
+  /**
+   * Filter to trades before (excluding) this sequence number.
+   * Default behaviour is not to include this filter.
+   */
+  protected $before_seq;
+
   /**
    * Limit to this number of trades (default 100).
    */
@@ -18,6 +35,12 @@ class ListUserTrades extends AbstractRequest
    * Filter to trades on or after this timestamp.
    */
   protected $since;
+
+  /**
+   * If set to true, sorts trades in descending order, otherwise ascending
+   * order will be assumed.
+   */
+  protected $sort_desc;
 
   /**
    * @return string
@@ -38,6 +61,63 @@ public function setPair(string $pair)
     $this->pair = $pair;
   }
 
+  /**
+   * @return int
+   */
+  public function getAfterSeq(): int
+  {
+    if (!isset($this->after_seq)) {
+      return 0;
+    }
+    return $this->after_seq;
+  }
+
+  /**
+   * @param int $afterSeq
+   */
+  public function setAfterSeq(int $afterSeq)
+  {
+    $this->after_seq = $afterSeq;
+  }
+
+  /**
+   * @return int
+   */
+  public function getBefore(): int
+  {
+    if (!isset($this->before)) {
+      return 0;
+    }
+    return $this->before;
+  }
+
+  /**
+   * @param int $before
+   */
+  public function setBefore(int $before)
+  {
+    $this->before = $before;
+  }
+
+  /**
+   * @return int
+   */
+  public function getBeforeSeq(): int
+  {
+    if (!isset($this->before_seq)) {
+      return 0;
+    }
+    return $this->before_seq;
+  }
+
+  /**
+   * @param int $beforeSeq
+   */
+  public function setBeforeSeq(int $beforeSeq)
+  {
+    $this->before_seq = $beforeSeq;
+  }
+
   /**
    * @return int
    */
@@ -75,6 +155,25 @@ public function setSince(int $since)
   {
     $this->since = $since;
   }
+
+  /**
+   * @return bool
+   */
+  public function getSortDesc(): bool
+  {
+    if (!isset($this->sort_desc)) {
+      return false;
+    }
+    return $this->sort_desc;
+  }
+
+  /**
+   * @param bool $sortDesc
+   */
+  public function setSortDesc(bool $sortDesc)
+  {
+    $this->sort_desc = $sortDesc;
+  }
 }
 
 // vi: ft=php

src/Luno/Types/OrderState.php

@@ -4,8 +4,8 @@
 
 class OrderState
 {
-  const PENDING = "PENDING";
   const COMPLETE = "COMPLETE";
+  const PENDING = "PENDING";
 }
 
 // vi: ft=php

src/Luno/Types/Trade.php

@@ -12,6 +12,7 @@ class Trade
   protected $order_id;
   protected $pair;
   protected $price;
+  protected $sequence;
   protected $timestamp;
   protected $type;
   protected $volume;
@@ -168,6 +169,25 @@ public function setPrice(float $price)
     $this->price = $price;
   }
 
+  /**
+   * @return int
+   */
+  public function getSequence(): int
+  {
+    if (!isset($this->sequence)) {
+      return 0;
+    }
+    return $this->sequence;
+  }
+
+  /**
+   * @param int $sequence
+   */
+  public function setSequence(int $sequence)
+  {
+    $this->sequence = $sequence;
+  }
+
   /**
    * @return int
    */