@d8x/perpetuals-sdk 0.1.10 → 0.1.12

package/dist/bundle.js

@@ -4072,20 +4072,23 @@ var PerpetualDataHandler = /** @class */ (function () {
      */
     PerpetualDataHandler.prototype._fillSymbolMaps = function (proxyContract) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, requiredPairs, _loop_1, this_1, j;
+            var oracleFactoryAddr, _a, requiredPairs, _loop_1, this_1, j;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         if (proxyContract == null || this.lobFactoryContract == null) {
                             throw Error("proxy or limit order book not defined");
                         }
+                        return [4 /*yield*/, proxyContract.getOracleFactory()];
+                    case 1:
+                        oracleFactoryAddr = _b.sent();
                         _a = this;
                         return [4 /*yield*/, PerpetualDataHandler.getNestedPerpetualIds(proxyContract)];
-                    case 1:
+                    case 2:
                         _a.nestedPerpetualIDs = _b.sent();
                         requiredPairs = new Set();
                         _loop_1 = function (j) {
-                            var pool, poolMarginTokenAddr, perpetualIDs, poolCCY, currentSymbols, currentSymbolsS3, currentLimitOrderBookAddr, ccy, initRate, mgnRate, lotSizes, refRebates, k, perp, base, quote, base3, quote3, sym, sym3, lobAddr, oracleFactoryAddr, info, currentSymbols3, k, idsB32, isPyth;
+                            var pool, poolMarginTokenAddr, perpetualIDs, poolCCY, currentSymbols, currentSymbolsS3, currentLimitOrderBookAddr, ccy, initRate, mgnRate, lotSizes, refRebates, k, perp, base, quote, base3, quote3, sym, sym3, lobAddr, info, currentSymbols3, k, idsB32, isPyth;
                             var _c;
                             return __generator(this, function (_d) {
                                 switch (_d.label) {
@@ -4157,9 +4160,6 @@ var PerpetualDataHandler = /** @class */ (function () {
                                         if (perpetualIDs.length == 0) {
                                             return [2 /*return*/, "continue"];
                                         }
-                                        return [4 /*yield*/, proxyContract.getOracleFactory()];
-                                    case 7:
-                                        oracleFactoryAddr = _d.sent();
                                         info = {
                                             poolId: j + 1,
                                             poolMarginSymbol: poolCCY,
@@ -4170,12 +4170,12 @@ var PerpetualDataHandler = /** @class */ (function () {
                                         this_1.poolStaticInfos.push(info);
                                         currentSymbols3 = currentSymbols.map(function (x) { return x + "-" + poolCCY; });
                                         k = 0;
-                                        _d.label = 8;
-                                    case 8:
-                                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 11];
+                                        _d.label = 7;
+                                    case 7:
+                                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 10];
                                         idsB32 = void 0, isPyth = void 0;
                                         return [4 /*yield*/, proxyContract.getPriceInfo(perpetualIDs[k])];
-                                    case 9:
+                                    case 8:
                                         _c = __read.apply(void 0, [_d.sent(), 2]), idsB32 = _c[0], isPyth = _c[1];
                                         this_1.symbolToPerpStaticInfo.set(currentSymbols3[k], {
                                             id: perpetualIDs[k],
@@ -4189,11 +4189,11 @@ var PerpetualDataHandler = /** @class */ (function () {
                                             referralRebate: refRebates[k],
                                             priceIds: idsB32,
                                         });
-                                        _d.label = 10;
-                                    case 10:
+                                        _d.label = 9;
+                                    case 9:
                                         k++;
-                                        return [3 /*break*/, 8];
-                                    case 11:
+                                        return [3 /*break*/, 7];
+                                    case 10:
                                         // push margin token address into map
                                         this_1.symbolToTokenAddrMap.set(poolCCY, poolMarginTokenAddr);
                                         return [2 /*return*/];
@@ -4202,17 +4202,17 @@ var PerpetualDataHandler = /** @class */ (function () {
                         };
                         this_1 = this;
                         j = 0;
-                        _b.label = 2;
-                    case 2:
-                        if (!(j < this.nestedPerpetualIDs.length)) return [3 /*break*/, 5];
-                        return [5 /*yield**/, _loop_1(j)];
+                        _b.label = 3;
                     case 3:
-                        _b.sent();
-                        _b.label = 4;
+                        if (!(j < this.nestedPerpetualIDs.length)) return [3 /*break*/, 6];
+                        return [5 /*yield**/, _loop_1(j)];
                     case 4:
-                        j++;
-                        return [3 /*break*/, 2];
+                        _b.sent();
+                        _b.label = 5;
                     case 5:
+                        j++;
+                        return [3 /*break*/, 3];
+                    case 6:
                         // pre-calculate all triangulation paths so we can easily get from
                         // the prices of price-feeds to the index price required, e.g.
                         // BTC-USDC : BTC-USD / USDC-USD
@@ -6810,7 +6810,7 @@ exports.containsFlag = containsFlag;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.D8X_SDK_VERSION = void 0;
-exports.D8X_SDK_VERSION = "0.1.10";
+exports.D8X_SDK_VERSION = "0.1.12";
 //# sourceMappingURL=version.js.map
 
 /***/ }),
@@ -6901,7 +6901,6 @@ var WriteAccessHandler = /** @class */ (function (_super) {
         _this.traderAddr = "";
         _this.signer = null;
         _this.gasLimit = 15000000;
-        _this.chainId = 0;
         if (privateKey) {
             _this.privateKey = privateKey;
         }
@@ -6924,9 +6923,9 @@ var WriteAccessHandler = /** @class */ (function (_super) {
      */
     WriteAccessHandler.prototype.createProxyInstance = function (provider) {
         return __awaiter(this, void 0, void 0, function () {
-            var wallet, _a, _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var wallet, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         if (provider == undefined) {
                             this.provider = new ethers_1.ethers.providers.JsonRpcBatchProvider(this.nodeURL);
@@ -6940,15 +6939,11 @@ var WriteAccessHandler = /** @class */ (function (_super) {
                         }
                         return [4 /*yield*/, this.initContractsAndData(this.signer)];
                     case 1:
-                        _c.sent();
+                        _b.sent();
                         _a = this;
                         return [4 /*yield*/, this.signer.getAddress()];
                     case 2:
-                        _a.traderAddr = _c.sent();
-                        _b = this;
-                        return [4 /*yield*/, this.provider.getNetwork()];
-                    case 3:
-                        _b.chainId = (_c.sent()).chainId;
+                        _a.traderAddr = _b.sent();
                         return [2 /*return*/];
                 }
             });

package/dist/src/perpetualDataHandler.js

@@ -159,20 +159,23 @@ var PerpetualDataHandler = /** @class */ (function () {
      */
     PerpetualDataHandler.prototype._fillSymbolMaps = function (proxyContract) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, requiredPairs, _loop_1, this_1, j;
+            var oracleFactoryAddr, _a, requiredPairs, _loop_1, this_1, j;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         if (proxyContract == null || this.lobFactoryContract == null) {
                             throw Error("proxy or limit order book not defined");
                         }
+                        return [4 /*yield*/, proxyContract.getOracleFactory()];
+                    case 1:
+                        oracleFactoryAddr = _b.sent();
                         _a = this;
                         return [4 /*yield*/, PerpetualDataHandler.getNestedPerpetualIds(proxyContract)];
-                    case 1:
+                    case 2:
                         _a.nestedPerpetualIDs = _b.sent();
                         requiredPairs = new Set();
                         _loop_1 = function (j) {
-                            var pool, poolMarginTokenAddr, perpetualIDs, poolCCY, currentSymbols, currentSymbolsS3, currentLimitOrderBookAddr, ccy, initRate, mgnRate, lotSizes, refRebates, k, perp, base, quote, base3, quote3, sym, sym3, lobAddr, oracleFactoryAddr, info, currentSymbols3, k, idsB32, isPyth;
+                            var pool, poolMarginTokenAddr, perpetualIDs, poolCCY, currentSymbols, currentSymbolsS3, currentLimitOrderBookAddr, ccy, initRate, mgnRate, lotSizes, refRebates, k, perp, base, quote, base3, quote3, sym, sym3, lobAddr, info, currentSymbols3, k, idsB32, isPyth;
                             var _c;
                             return __generator(this, function (_d) {
                                 switch (_d.label) {
@@ -244,9 +247,6 @@ var PerpetualDataHandler = /** @class */ (function () {
                                         if (perpetualIDs.length == 0) {
                                             return [2 /*return*/, "continue"];
                                         }
-                                        return [4 /*yield*/, proxyContract.getOracleFactory()];
-                                    case 7:
-                                        oracleFactoryAddr = _d.sent();
                                         info = {
                                             poolId: j + 1,
                                             poolMarginSymbol: poolCCY,
@@ -257,12 +257,12 @@ var PerpetualDataHandler = /** @class */ (function () {
                                         this_1.poolStaticInfos.push(info);
                                         currentSymbols3 = currentSymbols.map(function (x) { return x + "-" + poolCCY; });
                                         k = 0;
-                                        _d.label = 8;
-                                    case 8:
-                                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 11];
+                                        _d.label = 7;
+                                    case 7:
+                                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 10];
                                         idsB32 = void 0, isPyth = void 0;
                                         return [4 /*yield*/, proxyContract.getPriceInfo(perpetualIDs[k])];
-                                    case 9:
+                                    case 8:
                                         _c = __read.apply(void 0, [_d.sent(), 2]), idsB32 = _c[0], isPyth = _c[1];
                                         this_1.symbolToPerpStaticInfo.set(currentSymbols3[k], {
                                             id: perpetualIDs[k],
@@ -276,11 +276,11 @@ var PerpetualDataHandler = /** @class */ (function () {
                                             referralRebate: refRebates[k],
                                             priceIds: idsB32,
                                         });
-                                        _d.label = 10;
-                                    case 10:
+                                        _d.label = 9;
+                                    case 9:
                                         k++;
-                                        return [3 /*break*/, 8];
-                                    case 11:
+                                        return [3 /*break*/, 7];
+                                    case 10:
                                         // push margin token address into map
                                         this_1.symbolToTokenAddrMap.set(poolCCY, poolMarginTokenAddr);
                                         return [2 /*return*/];
@@ -289,17 +289,17 @@ var PerpetualDataHandler = /** @class */ (function () {
                         };
                         this_1 = this;
                         j = 0;
-                        _b.label = 2;
-                    case 2:
-                        if (!(j < this.nestedPerpetualIDs.length)) return [3 /*break*/, 5];
-                        return [5 /*yield**/, _loop_1(j)];
+                        _b.label = 3;
                     case 3:
-                        _b.sent();
-                        _b.label = 4;
+                        if (!(j < this.nestedPerpetualIDs.length)) return [3 /*break*/, 6];
+                        return [5 /*yield**/, _loop_1(j)];
                     case 4:
-                        j++;
-                        return [3 /*break*/, 2];
+                        _b.sent();
+                        _b.label = 5;
                     case 5:
+                        j++;
+                        return [3 /*break*/, 3];
+                    case 6:
                         // pre-calculate all triangulation paths so we can easily get from
                         // the prices of price-feeds to the index price required, e.g.
                         // BTC-USDC : BTC-USD / USDC-USD

package/dist/src/version.d.ts

@@ -1 +1 @@
-export declare const D8X_SDK_VERSION = "0.1.10";
+export declare const D8X_SDK_VERSION = "0.1.12";

package/dist/src/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.D8X_SDK_VERSION = void 0;
-exports.D8X_SDK_VERSION = "0.1.10";
+exports.D8X_SDK_VERSION = "0.1.12";
 //# sourceMappingURL=version.js.map

package/dist/src/writeAccessHandler.d.ts

@@ -13,7 +13,6 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
     protected traderAddr: string;
     protected signer: ethers.Signer | null;
     protected gasLimit: number;
-    protected chainId: number;
     /**
      * Constructor
      * @param {NodeSDKConfig} config configuration

package/dist/src/writeAccessHandler.js

@@ -77,7 +77,6 @@ var WriteAccessHandler = /** @class */ (function (_super) {
         _this.traderAddr = "";
         _this.signer = null;
         _this.gasLimit = 15000000;
-        _this.chainId = 0;
         if (privateKey) {
             _this.privateKey = privateKey;
         }
@@ -100,9 +99,9 @@ var WriteAccessHandler = /** @class */ (function (_super) {
      */
     WriteAccessHandler.prototype.createProxyInstance = function (provider) {
         return __awaiter(this, void 0, void 0, function () {
-            var wallet, _a, _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var wallet, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         if (provider == undefined) {
                             this.provider = new ethers_1.ethers.providers.JsonRpcBatchProvider(this.nodeURL);
@@ -116,15 +115,11 @@ var WriteAccessHandler = /** @class */ (function (_super) {
                         }
                         return [4 /*yield*/, this.initContractsAndData(this.signer)];
                     case 1:
-                        _c.sent();
+                        _b.sent();
                         _a = this;
                         return [4 /*yield*/, this.signer.getAddress()];
                     case 2:
-                        _a.traderAddr = _c.sent();
-                        _b = this;
-                        return [4 /*yield*/, this.provider.getNetwork()];
-                    case 3:
-                        _b.chainId = (_c.sent()).chainId;
+                        _a.traderAddr = _b.sent();
                         return [2 /*return*/];
                 }
             });

package/doc/accountTrade.md

@@ -0,0 +1,249 @@
+<a name="AccountTrade"></a>
+
+## AccountTrade ⇐ <code>WriteAccessHandler</code>
+<p>Functions to create, submit and cancel orders on the exchange.
+This class requires a private key and executes smart-contract interactions that
+require gas-payments.</p>
+
+**Kind**: global class  
+**Extends**: <code>WriteAccessHandler</code>  
+
+* [AccountTrade](#AccountTrade) ⇐ <code>WriteAccessHandler</code>
+    * [new AccountTrade(config, privateKey)](#new_AccountTrade_new)
+    * [.cancelOrder(symbol, orderId)](#AccountTrade+cancelOrder) ⇒ <code>ContractTransaction</code>
+    * [.order(order)](#AccountTrade+order) ⇒ <code>ContractTransaction</code>
+    * [.queryExchangeFee(poolSymbolName, [brokerAddr])](#AccountTrade+queryExchangeFee) ⇒
+    * [.getCurrentTraderVolume(poolSymbolName)](#AccountTrade+getCurrentTraderVolume) ⇒ <code>number</code>
+    * [.getOrderIds(symbol)](#AccountTrade+getOrderIds) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.addCollateral(symbol, amount)](#AccountTrade+addCollateral)
+    * [.removeCollateral(symbol, amount)](#AccountTrade+removeCollateral)
+
+<a name="new_AccountTrade_new"></a>
+
+### new AccountTrade(config, privateKey)
+<p>Constructor</p>
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>NodeSDKConfig</code> | <p>Configuration object, see PerpetualDataHandler. readSDKConfig.</p> |
+| privateKey | <code>string</code> | <p>Private key of account that trades.</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+async function main() {
+  console.log(AccountTrade);
+  // load configuration for testnet
+  const config = PerpetualDataHandler.readSDKConfig("testnet");
+  // AccountTrade (authentication required, PK is an environment variable with a private key)
+  const pk: string = <string>process.env.PK;
+  let accTrade = new AccountTrade(config, pk);
+  // Create a proxy instance to access the blockchain
+  await accTrade.createProxyInstance();
+}
+main();
+```
+<a name="AccountTrade+cancelOrder"></a>
+
+### accountTrade.cancelOrder(symbol, orderId) ⇒ <code>ContractTransaction</code>
+<p>Cancels an existing order on the exchange.</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Returns**: <code>ContractTransaction</code> - <p>Contract Transaction (containing events).</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| symbol | <code>string</code> | <p>Symbol of the form ETH-USD-MATIC.</p> |
+| orderId | <code>string</code> | <p>ID of the order to be cancelled.</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
+async function main() {
+   console.log(AccountTrade);
+   // setup (authentication required, PK is an environment variable with a private key)
+   const config = PerpetualDataHandler.readSDKConfig("testnet");
+   const pk: string = <string>process.env.PK;
+   let accTrade = new AccountTrade(config, pk);
+   await accTrade.createProxyInstance();
+   // cancel order
+   let cancelTransaction = accTrade.cancelOrder("MATIC-USD-MATIC",
+       "0x4639061a58dcf34f4c9c703f49f1cb00d6a4fba490d62c0eb4a4fb06e1c76c19")
+   console.log(cancelTransaction);
+ }
+ main();
+```
+<a name="AccountTrade+order"></a>
+
+### accountTrade.order(order) ⇒ <code>ContractTransaction</code>
+<p>Submits an order to the exchange.</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Returns**: <code>ContractTransaction</code> - <p>Contract Transaction (containing events).</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| order | <code>Order</code> | <p>Order structure. As a minimum the structure needs to specify symbol, side, type and quantity.</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
+async function main() {
+   console.log(AccountTrade);
+   // setup (authentication required, PK is an environment variable with a private key)
+   const config = PerpetualDataHandler.readSDKConfig("testnet");
+   const pk: string = <string>process.env.PK;
+   let accTrade = new AccountTrade(config, pk);
+   await accTrade.createProxyInstance();
+   // set allowance
+   await accTrade.setAllowance("MATIC");
+   // set an order
+   let order: Order = {
+       symbol: "MATIC-USD-MATIC",
+       side: "BUY",
+       type: "MARKET",
+       quantity: 100,
+       leverage: 2,
+       timestamp: Date.now()/1000,
+   };
+   let orderTransaction = await accTrade.order(order);
+   console.log(orderTransaction);
+ }
+ main();
+```
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
+async function main() {
+   console.log(AccountTrade);
+   // setup (authentication required, PK is an environment variable with a private key)
+   const config = PerpetualDataHandler.readSDKConfig("testnet");
+   const pk: string = <string>process.env.PK;
+   let accTrade = new AccountTrade(config, pk);
+   await accTrade.createProxyInstance();
+   // set allowance
+   await accTrade.setAllowance("MATIC");
+   // set an order
+  let order: Order = {
+      symbol: "MATIC-USD-MATIC",
+      side: "BUY",
+      type: "LIMIT",
+      limitPrice: 1,
+      quantity: 5,
+      leverage: 2,
+      timestamp: Date.now() / 1000,
+      deadline: Date.now() / 1000 + 8*60*60, // order expires 8 hours from now
+   };
+   let orderTransaction = await accTrade.order(order);
+   console.log(orderTransaction);
+ }
+ main();
+```
+<a name="AccountTrade+queryExchangeFee"></a>
+
+### accountTrade.queryExchangeFee(poolSymbolName, [brokerAddr]) ⇒
+<p>Fee charged by the exchange for trading any perpetual on a given pool.
+It accounts for the current trader's fee tier (based on the trader's D8X balance and trading volume).
+If trading with a broker, it also accounts for the selected broker's fee tier.
+Note that this result only includes exchange fees, additional broker fees are not included.</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Returns**: <p>Exchange fee, in decimals (i.e. 0.1% is 0.001).</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| poolSymbolName | <code>string</code> | <p>Pool symbol name (e.g. MATIC, USDC, etc).</p> |
+| [brokerAddr] | <code>string</code> | <p>Optional address of a broker this trader may use to trade under.</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+async function main() {
+  console.log(AccountTrade);
+  // setup (authentication required, PK is an environment variable with a private key)
+  const config = PerpetualDataHandler.readSDKConfig("testnet");
+  const pk: string = <string>process.env.PK;
+  let accTrade = new AccountTrade(config, pk);
+  await accTrade.createProxyInstance();
+  // query exchange fee
+  let fees = await accTrade.queryExchangeFee("MATIC");
+  console.log(fees);
+}
+main();
+```
+<a name="AccountTrade+getCurrentTraderVolume"></a>
+
+### accountTrade.getCurrentTraderVolume(poolSymbolName) ⇒ <code>number</code>
+<p>Exponentially weighted EMA of the total USD trading volume of all trades performed by this trader.
+The weights are chosen so that in average this coincides with the 30 day volume.</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Returns**: <code>number</code> - <p>Current trading volume for this trader, in USD.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| poolSymbolName | <code>string</code> | <p>Pool symbol name (e.g. MATIC, USDC, etc).</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+async function main() {
+  console.log(AccountTrade);
+  // setup (authentication required, PK is an environment variable with a private key)
+  const config = PerpetualDataHandler.readSDKConfig("testnet");
+  const pk: string = <string>process.env.PK;
+  let accTrade = new AccountTrade(config, pk);
+  await accTrade.createProxyInstance();
+  // query 30 day volume
+  let vol = await accTrade.getCurrentTraderVolume("MATIC");
+  console.log(vol);
+}
+main();
+```
+<a name="AccountTrade+getOrderIds"></a>
+
+### accountTrade.getOrderIds(symbol) ⇒ <code>Array.&lt;string&gt;</code>
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Returns**: <code>Array.&lt;string&gt;</code> - <p>Array of Ids for all the orders currently open by this trader.</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>Symbol of the form ETH-USD-MATIC.</p> |
+
+**Example**  
+```js
+import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+async function main() {
+  console.log(AccountTrade);
+  // setup (authentication required, PK is an environment variable with a private key)
+  const config = PerpetualDataHandler.readSDKConfig("testnet");
+  const pk: string = <string>process.env.PK;
+  let accTrade = new AccountTrade(config, pk);
+  await accTrade.createProxyInstance();
+  // get order IDs
+  let orderIds = await accTrade.getOrderIds("MATIC-USD-MATIC");
+  console.log(orderIds);
+}
+main();
+```
+<a name="AccountTrade+addCollateral"></a>
+
+### accountTrade.addCollateral(symbol, amount)
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| symbol | <code>string</code> | <p>Symbol of the form ETH-USD-MATIC.</p> |
+| amount | <code>number</code> | <p>How much collateral to add, in units of collateral currency, e.g. MATIC</p> |
+
+<a name="AccountTrade+removeCollateral"></a>
+
+### accountTrade.removeCollateral(symbol, amount)
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| symbol | <code>string</code> | <p>Symbol of the form ETH-USD-MATIC.</p> |
+| amount | <code>number</code> | <p>How much collateral to remove, in units of collateral currency, e.g. MATIC</p> |
+