Add support for order expiration

XRPLF · Oct 30, 2015 · 665f5f9 · 665f5f9
1 parent 36806e4
commit 665f5f9
Show file tree

Hide file tree

Showing 22 changed files with 253 additions and 42 deletions.
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
     "ripple-binary-codec": "^0.0.6",
     "ripple-hashes": "^0.0.1",
     "ripple-keypairs": "^0.10.0",
-    "ripple-lib-transactionparser": "^0.5.1",
+    "ripple-lib-transactionparser": "^0.6.0",
     "ws": "~0.7.1"
   },
   "devDependencies": {

diff --git a/src/common/schemas/order-change.json b/src/common/schemas/order-change.json
@@ -7,11 +7,12 @@
       "type": "string",
       "enum": ["buy", "sell"]
     },
-    "quantity": {"$ref": "balance"},
-    "totalPrice": {"$ref": "balance"},
+    "quantity": {"$ref": "amount"},
+    "totalPrice": {"$ref": "amount"},
     "makerExchangeRate": {"$ref": "value"},
     "sequence": {"$ref": "sequence"},
-    "status": {"enum": ["created", "open", "closed", "canceled"]}
+    "status": {"enum": ["created", "filled", "partially-filled", "cancelled"]},
+    "expirationTime": {"type": "string", "format": "date-time"}
   },
   "required": ["direction", "quantity", "totalPrice", "sequence", "status"],
   "additionalProperties": false

diff --git a/src/common/schemas/order.json b/src/common/schemas/order.json
@@ -14,7 +14,8 @@
     "passive": {
       "description": "If enabled, the offer will not consume offers that exactly match it, and instead becomes an Offer node in the ledger. It will still consume offers that cross it.",
       "type": "boolean"
-    }
+    },
+    "expirationTime": {"type": "string", "format": "date-time"}
   },
   "required": ["direction", "quantity", "totalPrice"],
   "additionalProperties": false,

diff --git a/src/ledger/parse/account-order.js b/src/ledger/parse/account-order.js
@@ -26,7 +26,9 @@ function parseAccountOrder(address: string, order: Object): Object {
     direction: direction,
     quantity: quantity,
     totalPrice: totalPrice,
-    passive: ((order.flags & flags.Passive) !== 0) || undefined
+    passive: ((order.flags & flags.Passive) !== 0) || undefined,
+    // rippled currently does not provide "expiration" in account_offers
+    expirationTime: utils.parseTimestamp(order.expiration)
   });
 
   const properties = {

diff --git a/src/ledger/parse/order.js b/src/ledger/parse/order.js
@@ -21,7 +21,8 @@ function parseOrder(tx: Object): Object {
     passive: ((tx.Flags & flags.Passive) !== 0) || undefined,
     immediateOrCancel: ((tx.Flags & flags.ImmediateOrCancel) !== 0)
       || undefined,
-    fillOrKill: ((tx.Flags & flags.FillOrKill) !== 0) || undefined
+    fillOrKill: ((tx.Flags & flags.FillOrKill) !== 0) || undefined,
+    expirationTime: utils.parseTimestamp(tx.Expiration)
   });
 }
 

diff --git a/src/ledger/parse/orderbook-order.js b/src/ledger/parse/orderbook-order.js
@@ -18,7 +18,8 @@ function parseOrderbookOrder(order: Object): Object {
     direction: direction,
     quantity: quantity,
     totalPrice: totalPrice,
-    passive: ((order.Flags & flags.Passive) !== 0) || undefined
+    passive: ((order.Flags & flags.Passive) !== 0) || undefined,
+    expirationTime: utils.parseTimestamp(order.Expiration)
   });
 
   const properties = {

diff --git a/src/ledger/parse/utils.js b/src/ledger/parse/utils.js
@@ -18,8 +18,8 @@ function adjustQualityForXRP(
     (new BigNumber(quality)).shift(shift).toString();
 }
 
-function parseTimestamp(tx: {date: string}): string | void {
-  return tx.date ? (new Date(rippleToUnixTimestamp(tx.date))).toISOString()
+function parseTimestamp(date: number): string | void {
+  return date ? (new Date(rippleToUnixTimestamp(date))).toISOString()
     : undefined;
 }
 
@@ -55,7 +55,7 @@ function parseOutcome(tx: Object): ?Object {
 
   return {
     result: tx.meta.TransactionResult,
-    timestamp: parseTimestamp(tx),
+    timestamp: parseTimestamp(tx.date),
     fee: utils.common.dropsToXrp(tx.Fee),
     balanceChanges: balanceChanges,
     orderbookChanges: orderbookChanges,
@@ -85,6 +85,7 @@ module.exports = {
   parseOutcome,
   parseMemos,
   hexToString,
+  parseTimestamp,
   adjustQualityForXRP,
   dropsToXrp: utils.common.dropsToXrp,
   constants: utils.common.constants,

diff --git a/src/transaction/order.js b/src/transaction/order.js
@@ -3,6 +3,7 @@
 const utils = require('./utils');
 const validate = utils.common.validate;
 const offerFlags = utils.common.txFlags.OfferCreate;
+const unixToRippleTimestamp = utils.common.unixToRippleTimestamp;
 import type {Instructions, Prepare} from './types.js';
 import type {Order} from '../ledger/transaction-types.js';
 
@@ -34,6 +35,9 @@ function createOrderTransaction(account: string, order: Order): Object {
   if (order.fillOrKill === true) {
     txJSON.Flags |= offerFlags.FillOrKill;
   }
+  if (order.expirationTime !== undefined) {
+    txJSON.Expiration = unixToRippleTimestamp(Date.parse(order.expirationTime));
+  }
   return txJSON;
 }
 

diff --git a/test/api-test.js b/test/api-test.js
@@ -83,14 +83,22 @@ describe('RippleAPI', function() {
   });
 
   it('prepareOrder - buy order', function() {
-    return this.api.prepareOrder(address, requests.prepareOrder, instructions)
-      .then(_.partial(checkResult, responses.prepareOrder, 'prepare'));
+    const request = requests.prepareOrder.buy;
+    return this.api.prepareOrder(address, request, instructions)
+      .then(_.partial(checkResult, responses.prepareOrder.buy, 'prepare'));
+  });
+
+  it('prepareOrder - buy order with expiration', function() {
+    const request = requests.prepareOrder.expiration;
+    const response = responses.prepareOrder.expiration;
+    return this.api.prepareOrder(address, request, instructions)
+      .then(_.partial(checkResult, response, 'prepare'));
   });
 
   it('prepareOrder - sell order', function() {
-    return this.api.prepareOrder(
-      address, requests.prepareOrderSell, instructions).then(
-      _.partial(checkResult, responses.prepareOrderSell, 'prepare'));
+    const request = requests.prepareOrder.sell;
+    return this.api.prepareOrder(address, request, instructions).then(
+      _.partial(checkResult, responses.prepareOrder.sell, 'prepare'));
   });
 
   it('prepareOrderCancellation', function() {
@@ -280,6 +288,15 @@ describe('RippleAPI', function() {
           'getTransaction'));
     });
 
+    it('getTransaction - order with expiration cancellation', function() {
+      const hash =
+        '097B9491CC76B64831F1FEA82EAA93BCD728106D90B65A072C933888E946C40B';
+      return this.api.getTransaction(hash).then(
+        _.partial(checkResult,
+          responses.getTransaction.orderWithExpirationCancellation,
+          'getTransaction'));
+    });
+
     it('getTransaction - trustline set', function() {
       const hash =
         '635A0769BD94710A1F6A76CDE65A3BC661B20B798807D1BBBDADCEA26420538D';

diff --git a/test/fixtures/api/requests/index.js b/test/fixtures/api/requests/index.js
@@ -1,8 +1,11 @@
 'use strict';
 
 module.exports = {
-  prepareOrder: require('./prepare-order'),
-  prepareOrderSell: require('./prepare-order-sell'),
+  prepareOrder: {
+    buy: require('./prepare-order'),
+    sell: require('./prepare-order-sell'),
+    expiration: require('./prepare-order-expiration')
+  },
   preparePayment: require('./prepare-payment'),
   preparePaymentAllOptions: require('./prepare-payment-all-options'),
   preparePaymentNoCounterparty: require('./prepare-payment-no-counterparty'),

diff --git a/test/fixtures/api/requests/prepare-order-expiration.json b/test/fixtures/api/requests/prepare-order-expiration.json
@@ -0,0 +1,14 @@
+{
+  "direction": "buy",
+  "quantity": {
+    "currency": "USD",
+    "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+    "value": "10.1"
+  },
+  "totalPrice": {
+    "currency": "XRP",
+    "value": "2"
+  },
+  "immediateOrCancel": true,
+  "expirationTime": "2015-01-14T18:36:52.000Z"
+}
diff --git a/test/fixtures/api/responses/get-orderbook.json b/test/fixtures/api/responses/get-orderbook.json
@@ -52,7 +52,8 @@
           "currency": "BTC",
           "value": "0.3",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-25T01:14:43.000Z"
       },
       "properties": {
         "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk",
@@ -104,7 +105,8 @@
           "currency": "BTC",
           "value": "0.4499999999999999",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-25T01:14:44.000Z"
       },
       "properties": {
         "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk",
@@ -144,7 +146,8 @@
           "currency": "BTC",
           "value": "0.5",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-25T00:41:38.000Z"
       },
       "properties": {
         "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE",
@@ -196,7 +199,8 @@
           "currency": "BTC",
           "value": "0.8",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-25T00:41:39.000Z"
       },
       "properties": {
         "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE",
@@ -290,7 +294,8 @@
           "currency": "BTC",
           "value": "0.4499999999999999",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-25T01:14:44.000Z"
       },
       "properties": {
         "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk",
@@ -322,7 +327,8 @@
           "currency": "BTC",
           "value": "0.8",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-24T21:44:11.000Z"
       },
       "properties": {
         "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE",
@@ -434,7 +440,8 @@
           "currency": "BTC",
           "value": "1.6",
           "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
+        },
+        "expirationTime": "2014-12-24T21:44:12.000Z"
       },
       "properties": {
         "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE",

diff --git a/test/fixtures/api/responses/get-transaction-order-cancellation.json b/test/fixtures/api/responses/get-transaction-order-cancellation.json
@@ -25,15 +25,15 @@
           "quantity": {
             "currency": "USD",
             "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
-            "value": "0"
+            "value": "237"
           },
           "totalPrice": {
             "currency": "XRP",
-            "value": "0"
+            "value": "0.0002"
           },
           "makerExchangeRate": "1185000",
           "sequence": 465,
-          "status": "canceled"
+          "status": "cancelled"
         }
       ]
     },

diff --git a/test/fixtures/api/responses/get-transaction-order-with-expiration-cancellation.json b/test/fixtures/api/responses/get-transaction-order-with-expiration-cancellation.json
@@ -0,0 +1,44 @@
+{
+  "type": "orderCancellation",
+  "address": "rBSZe33F5oxHTbxSF1nZJooVDpcrrqNFp3",
+  "sequence": 1122979,
+  "id": "097B9491CC76B64831F1FEA82EAA93BCD728106D90B65A072C933888E946C40B",
+  "specification": {
+    "orderSequence": 1122978
+  },
+  "outcome": {
+    "result": "tesSUCCESS",
+    "timestamp": "2015-01-14T18:27:00.000Z",
+    "fee": "0.011",
+    "balanceChanges": {
+      "rBSZe33F5oxHTbxSF1nZJooVDpcrrqNFp3": [
+        {
+          "currency": "XRP",
+          "value": "-0.011"
+        }
+      ]
+    },
+    "orderbookChanges": {
+      "rBSZe33F5oxHTbxSF1nZJooVDpcrrqNFp3": [
+        {
+          "direction": "buy",
+          "quantity": {
+            "currency": "CNY",
+            "counterparty": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
+            "value": "3200"
+          },
+          "totalPrice": {
+            "currency": "XRP",
+            "value": "34700.537395"
+          },
+          "sequence": 1122978,
+          "status": "cancelled",
+          "makerExchangeRate": "0.09221759200942773",
+          "expirationTime": "2015-01-14T18:36:52.000Z"
+        }
+      ]
+    },
+    "ledgerVersion": 11119599,
+    "indexInLedger": 15
+  }
+}
diff --git a/test/fixtures/api/responses/get-transaction-payment.json b/test/fixtures/api/responses/get-transaction-payment.json
@@ -68,16 +68,16 @@
           "direction": "buy",
           "quantity": {
             "currency": "XRP",
-            "value": "-1.101198"
+            "value": "1.101198"
           },
           "totalPrice": {
             "currency": "USD",
             "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
-            "value": "-0.001002"
+            "value": "0.001002"
           },
           "makerExchangeRate": "1099",
           "sequence": 58,
-          "status": "open"
+          "status": "partially-filled"
         }
       ]
     },

diff --git a/test/fixtures/api/responses/get-transactions.json b/test/fixtures/api/responses/get-transactions.json
@@ -74,16 +74,16 @@
             "direction": "buy",
             "quantity": {
               "currency": "XRP",
-              "value": "-1.101198"
+              "value": "1.101198"
             },
             "totalPrice": {
               "currency": "USD",
               "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
-              "value": "-0.001002"
+              "value": "0.001002"
             },
             "makerExchangeRate": "1099",
             "sequence": 58,
-            "status": "open"
+            "status": "partially-filled"
           }
         ]
       },
@@ -166,16 +166,16 @@
             "direction": "buy",
             "quantity": {
               "currency": "XRP",
-              "value": "-1.101198"
+              "value": "1.101198"
             },
             "totalPrice": {
               "currency": "USD",
               "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
-              "value": "-0.001002"
+              "value": "0.001002"
             },
             "makerExchangeRate": "1099",
             "sequence": 58,
-            "status": "open"
+            "status": "partially-filled"
           }
         ]
       },