Merge pull request #1980 from ExchangeUnion/rename-trading-limits

refactor(rpc): rename reserved TradingLimits fields
ExchangeUnion · Nov 6, 2020 · 74a59dc · 74a59dc
2 parents 17e40de + 721e098
commit 74a59dc
Show file tree

Hide file tree

Showing 12 changed files with 319 additions and 319 deletions.
diff --git a/docs/api.md b/docs/api.md
diff --git a/lib/cli/commands/tradinglimits.ts b/lib/cli/commands/tradinglimits.ts
@@ -9,8 +9,8 @@ const HEADERS = [
   colors.blue('Currency'),
   colors.blue('Max Buy'),
   colors.blue('Max Sell'),
-  colors.blue('Reserved Outbound'),
-  colors.blue('Reserved Inbound'),
+  colors.blue('Reserved Buy'),
+  colors.blue('Reserved Sell'),
 ];
 
 const formatTradingLimits = (tradingLimits: TradingLimitsResponse.AsObject) => {
@@ -23,8 +23,8 @@ const formatTradingLimits = (tradingLimits: TradingLimitsResponse.AsObject) => {
       currency,
       `${satsToCoinsStr(tradingLimit.maxBuy)}`,
       `${satsToCoinsStr(tradingLimit.maxSell)}`,
-      `${satsToCoinsStr(tradingLimit.reservedOutbound)}`,
-      `${satsToCoinsStr(tradingLimit.reservedInbound)}`,
+      `${satsToCoinsStr(tradingLimit.reservedBuy)}`,
+      `${satsToCoinsStr(tradingLimit.reservedSell)}`,
     );
     formatted.push(row);
   });

diff --git a/lib/grpc/GrpcService.ts b/lib/grpc/GrpcService.ts
@@ -350,8 +350,8 @@ class GrpcService {
         const tradingLimits = new xudrpc.TradingLimits();
         tradingLimits.setMaxSell(tradingLimitsObj.maxSell);
         tradingLimits.setMaxBuy(tradingLimitsObj.maxBuy);
-        tradingLimits.setReservedInbound(tradingLimitsObj.reservedInbound);
-        tradingLimits.setReservedOutbound(tradingLimitsObj.reservedOutbound);
+        tradingLimits.setReservedSell(tradingLimitsObj.reservedSell);
+        tradingLimits.setReservedBuy(tradingLimitsObj.reservedBuy);
         limitsMap.set(currency, tradingLimits);
       });
       callback(null, response);

diff --git a/lib/proto/xudrpc.swagger.json b/lib/proto/xudrpc.swagger.json
diff --git a/lib/proto/xudrpc_pb.d.ts b/lib/proto/xudrpc_pb.d.ts
diff --git a/lib/proto/xudrpc_pb.js b/lib/proto/xudrpc_pb.js
diff --git a/lib/swaps/SwapClientManager.ts b/lib/swaps/SwapClientManager.ts
@@ -185,8 +185,8 @@ class SwapClientManager extends EventEmitter {
       const availableInboundCapacity = Math.max(0, swapCapacities.totalInboundCapacity - reservedInbound);
 
       return {
-        reservedOutbound,
-        reservedInbound,
+        reservedSell: reservedOutbound,
+        reservedBuy: reservedInbound,
         maxSell: Math.min(swapCapacities.maxOutboundChannelCapacity, availableOutboundCapacity),
         maxBuy: Math.min(swapCapacities.maxInboundChannelCapacity, availableInboundCapacity),
       };

diff --git a/lib/swaps/types.ts b/lib/swaps/types.ts
@@ -120,14 +120,14 @@ export type SwapCapacities = {
 };
 
 export type TradingLimits = {
-  /** Maximum outbound limit for an order denominated in satoshis. */
+  /** Maximum outbound limit for a sell order denominated in satoshis. */
   maxSell: number,
-  /** Maximum inbound limit for an order denominated in satoshis. */
+  /** Maximum inbound limit for a buy order denominated in satoshis. */
   maxBuy: number,
-  /**  The outbound amount reserved for open orders. */
-  reservedOutbound: number,
-  /**  The inbound amount reserved for open orders. */
-  reservedInbound: number,
+  /**  The outbound amount reserved for open sell orders. */
+  reservedSell: number,
+  /**  The inbound amount reserved for open buy orders. */
+  reservedBuy: number,
 };
 
 export type ResolveRequest = {

diff --git a/proto/xudrpc.proto b/proto/xudrpc.proto
@@ -928,14 +928,14 @@ message TradeHistoryResponse {
 }
 
 message TradingLimits {
-  // Maximum outbound limit for an order denominated in satoshis.
+  // Maximum outbound limit for a sell order denominated in satoshis.
   uint64 max_sell = 1 [json_name = "max_sell"];
-  // Maximum inbound limit for an order denominated in satoshis.
+  // Maximum inbound limit for a buy order denominated in satoshis.
   uint64 max_buy = 2 [json_name = "max_buy"];
-  // The outbound amount reserved for open orders.
-  uint64 reserved_outbound = 3 [json_name = "reserved_outbound"];
-  // The inbound amount reserved for open orders.
-  uint64 reserved_inbound = 4 [json_name = "reserved_inbound"];
+  // The outbound amount reserved for open sell orders.
+  uint64 reserved_sell = 3 [json_name = "reserved_sell"];
+  // The inbound amount reserved for open buy orders.
+  uint64 reserved_buy = 4 [json_name = "reserved_buy"];
 }
 
 message TradingLimitsRequest {

diff --git a/test/jest/cli/__snapshots__/tradinglimits.spec.ts.snap b/test/jest/cli/__snapshots__/tradinglimits.spec.ts.snap
@@ -7,11 +7,11 @@ Array [
 Trading Limits:",
   ],
   Array [
-    "┌──────────┬────────────┬───────────┬───────────────────┬──────────────────┐
-│ Currency │ Max Buy    │ Max Sell  │ Reserved Outbound │ Reserved Inbound │
-├──────────┼────────────┼───────────┼───────────────────┼──────────────────┤
-│ BTC      │ 0.00012345 │ 0.0006789 │ 0.00075           │ 0.00025          │
-└──────────┴────────────┴───────────┴───────────────────┴──────────────────┘",
+    "┌──────────┬────────────┬───────────┬──────────────┬───────────────┐
+│ Currency │ Max Buy    │ Max Sell  │ Reserved Buy │ Reserved Sell │
+├──────────┼────────────┼───────────┼──────────────┼───────────────┤
+│ BTC      │ 0.00012345 │ 0.0006789 │ 0.00025      │ 0.00075       │
+└──────────┴────────────┴───────────┴──────────────┴───────────────┘",
   ],
 ]
 `;
diff --git a/test/jest/cli/tradinglimits.spec.ts b/test/jest/cli/tradinglimits.spec.ts
@@ -21,8 +21,8 @@ describe('displayLimits', () => {
       limitsMap: [['BTC', {
         maxBuy: 12345,
         maxSell: 67890,
-        reservedInbound: 25000,
-        reservedOutbound: 75000,
+        reservedBuy: 25000,
+        reservedSell: 75000,
       }]],
     });