@d8x/perpetuals-sdk 0.0.16 → 0.0.18

package/dist/marketData.d.ts

@@ -29,7 +29,13 @@ export default class MarketData extends PerpetualDataHandler {
      *
      */
     constructor(config: NodeSDKConfig);
-    createProxyInstance(): Promise<void>;
+    /**
+     * Initialize the marketData-Class with this function
+     * to create instance of D8X perpetual contract and gather information
+     * about perpetual currencies
+     * @param provider optional provider
+     */
+    createProxyInstance(provider?: ethers.providers.JsonRpcProvider): Promise<void>;
     /**
      * Get contract instance. Useful for event listening.
      * @example
@@ -73,14 +79,6 @@ export default class MarketData extends PerpetualDataHandler {
      * @param {string} traderAddr Address of the trader for which we get the open orders.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @example
-     * // Setup
-     * const config = PerpetualDataHandler.readSDKConfig("testnet");
-     * let mktData = new MarketData(config);
-     * await mktData.createProxyInstance();
-     * // Get all open orders for a trader/symbol
-     * let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-     *     "ETH-USD-MATIC");
-     * @example
      * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(MarketData);
@@ -106,14 +104,6 @@ export default class MarketData extends PerpetualDataHandler {
      * @param {string} traderAddr Address of the trader for which we get the position risk.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @example
-     * // Setup
-     * const config = PerpetualDataHandler.readSDKConfig("testnet");
-     * let mktData = new MarketData(config);
-     * await mktData.createProxyInstance();
-     * // Get position risk info
-     * let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-     *     "ETH-USD-MATIC");
-     * @example
      * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(MarketData);

package/dist/marketData.js

@@ -46,9 +46,20 @@ class MarketData extends perpetualDataHandler_1.default {
     constructor(config) {
         super(config);
     }
-    createProxyInstance() {
+    /**
+     * Initialize the marketData-Class with this function
+     * to create instance of D8X perpetual contract and gather information
+     * about perpetual currencies
+     * @param provider optional provider
+     */
+    createProxyInstance(provider) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.provider = new ethers_1.ethers.providers.JsonRpcProvider(this.nodeURL);
+            if (provider == undefined) {
+                this.provider = new ethers_1.ethers.providers.JsonRpcProvider(this.nodeURL);
+            }
+            else {
+                this.provider = provider;
+            }
             yield this.initContractsAndData(this.provider);
         });
     }
@@ -107,14 +118,6 @@ class MarketData extends perpetualDataHandler_1.default {
      * @param {string} traderAddr Address of the trader for which we get the open orders.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @example
-     * // Setup
-     * const config = PerpetualDataHandler.readSDKConfig("testnet");
-     * let mktData = new MarketData(config);
-     * await mktData.createProxyInstance();
-     * // Get all open orders for a trader/symbol
-     * let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-     *     "ETH-USD-MATIC");
-     * @example
      * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(MarketData);
@@ -147,14 +150,6 @@ class MarketData extends perpetualDataHandler_1.default {
      * @param {string} traderAddr Address of the trader for which we get the position risk.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @example
-     * // Setup
-     * const config = PerpetualDataHandler.readSDKConfig("testnet");
-     * let mktData = new MarketData(config);
-     * await mktData.createProxyInstance();
-     * // Get position risk info
-     * let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-     *     "ETH-USD-MATIC");
-     * @example
      * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(MarketData);

package/dist/perpetualDataHandler.js

@@ -416,8 +416,6 @@ class PerpetualDataHandler {
         }
         let iDeadline = order.deadline == undefined ? Date.now() / 1000 + nodeSDKTypes_1.ORDER_MAX_DURATION_SEC : order.deadline;
         let fTriggerPrice = order.stopPrice == undefined ? ethers_1.BigNumber.from(0) : (0, d8XMath_1.floatToABK64x64)(order.stopPrice);
-        if (order.reduceOnly != undefined && order.reduceOnly == true) {
-        }
         let smOrder = {
             flags: flags,
             iPerpetualId: ethers_1.BigNumber.from(perpetualId),
@@ -436,15 +434,17 @@ class PerpetualDataHandler {
         return smOrder;
     }
     static _flagToOrderType(order) {
-        let hasTrigger = ethers_1.BigNumber.from(order.fTriggerPrice).eq(0);
-        let hasLimit = !ethers_1.BigNumber.from(order.fTriggerPrice).eq(0) || !ethers_1.BigNumber.from(order.fTriggerPrice).eq(nodeSDKTypes_1.MAX_64x64);
-        if (hasTrigger && hasLimit) {
+        let flag = ethers_1.BigNumber.from(order.flags);
+        let isLimit = (0, utils_1.containsFlag)(flag, nodeSDKTypes_1.MASK_LIMIT_ORDER);
+        let hasLimit = !ethers_1.BigNumber.from(order.fLimitPrice).eq(0) || !ethers_1.BigNumber.from(order.fLimitPrice).eq(nodeSDKTypes_1.MAX_64x64);
+        let isStop = (0, utils_1.containsFlag)(flag, nodeSDKTypes_1.MASK_STOP_ORDER);
+        if (isStop && hasLimit) {
             return nodeSDKTypes_1.ORDER_TYPE_STOP_LIMIT;
         }
-        else if (hasTrigger && !hasLimit) {
+        else if (isStop && !hasLimit) {
             return nodeSDKTypes_1.ORDER_TYPE_STOP_MARKET;
         }
-        else if (hasLimit && (0, utils_1.containsFlag)(ethers_1.BigNumber.from(order.flags), nodeSDKTypes_1.MASK_LIMIT_ORDER)) {
+        else if (isLimit && !isStop) {
             return nodeSDKTypes_1.ORDER_TYPE_LIMIT;
         }
         else {
@@ -459,6 +459,7 @@ class PerpetualDataHandler {
      */
     static _orderTypeToFlag(order) {
         let flag;
+        order.type = order.type.toUpperCase();
         switch (order.type) {
             case nodeSDKTypes_1.ORDER_TYPE_LIMIT:
                 flag = nodeSDKTypes_1.MASK_LIMIT_ORDER;
@@ -491,7 +492,7 @@ class PerpetualDataHandler {
         if ((order.type == nodeSDKTypes_1.ORDER_TYPE_MARKET || order.type == nodeSDKTypes_1.ORDER_TYPE_LIMIT) && order.stopPrice != undefined) {
             throw Error(`Order type ${order.type} has no trigger price.`);
         }
-        if (order.type != nodeSDKTypes_1.ORDER_TYPE_MARKET && order.stopPrice != undefined) {
+        if (order.type != nodeSDKTypes_1.ORDER_TYPE_STOP_LIMIT && order.type != nodeSDKTypes_1.ORDER_TYPE_STOP_MARKET && order.stopPrice != undefined) {
             throw Error(`Order type ${order.type} has no trigger price.`);
         }
         return flag;

package/dist/writeAccessHandler.d.ts

@@ -21,11 +21,12 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
      */
     constructor(config: NodeSDKConfig, privateKey: string);
     /**
-     * Initialize the AccountTrade-Class with this function
+     * Initialize the writeAccessHandler-Class with this function
      * to create instance of D8X perpetual contract and gather information
      * about perpetual currencies
+     * @param provider optional provider
      */
-    createProxyInstance(): Promise<void>;
+    createProxyInstance(provider?: ethers.providers.JsonRpcProvider): Promise<void>;
     /**
      * Set allowance for ar margin token (e.g., MATIC, ETH, USDC)
      * @param symbol token in 'long-form' such as MATIC, symbol also fine (ETH-USD-MATIC)

package/dist/writeAccessHandler.js

@@ -42,13 +42,19 @@ class WriteAccessHandler extends perpetualDataHandler_1.default {
         }
     }
     /**
-     * Initialize the AccountTrade-Class with this function
+     * Initialize the writeAccessHandler-Class with this function
      * to create instance of D8X perpetual contract and gather information
      * about perpetual currencies
+     * @param provider optional provider
      */
-    createProxyInstance() {
+    createProxyInstance(provider) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.provider = new ethers_1.ethers.providers.JsonRpcProvider(this.nodeURL);
+            if (provider == undefined) {
+                this.provider = new ethers_1.ethers.providers.JsonRpcProvider(this.nodeURL);
+            }
+            else {
+                this.provider = provider;
+            }
             const wallet = new ethers_1.ethers.Wallet(this.privateKey);
             this.signer = wallet.connect(this.provider);
             yield this.initContractsAndData(this.signer);

package/package.json

@@ -27,7 +27,7 @@
   },
   "name": "@d8x/perpetuals-sdk",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "directories": {

package/src/marketData.ts

@@ -45,8 +45,18 @@ export default class MarketData extends PerpetualDataHandler {
     super(config);
   }
 
-  public async createProxyInstance() {
-    this.provider = new ethers.providers.JsonRpcProvider(this.nodeURL);
+  /**
+   * Initialize the marketData-Class with this function
+   * to create instance of D8X perpetual contract and gather information
+   * about perpetual currencies
+   * @param provider optional provider
+   */
+  public async createProxyInstance(provider?: ethers.providers.JsonRpcProvider) {
+    if (provider == undefined) {
+      this.provider = new ethers.providers.JsonRpcProvider(this.nodeURL);
+    } else {
+      this.provider = provider;
+    }
     await this.initContractsAndData(this.provider);
   }
 
@@ -105,14 +115,6 @@ export default class MarketData extends PerpetualDataHandler {
    * @param {string} traderAddr Address of the trader for which we get the open orders.
    * @param {string} symbol Symbol of the form ETH-USD-MATIC.
    * @example
-   * // Setup
-   * const config = PerpetualDataHandler.readSDKConfig("testnet");
-   * let mktData = new MarketData(config);
-   * await mktData.createProxyInstance();
-   * // Get all open orders for a trader/symbol
-   * let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-   *     "ETH-USD-MATIC");
-   * @example
    * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
    * async function main() {
    *   console.log(MarketData);
@@ -144,14 +146,6 @@ export default class MarketData extends PerpetualDataHandler {
    * @param {string} traderAddr Address of the trader for which we get the position risk.
    * @param {string} symbol Symbol of the form ETH-USD-MATIC.
    * @example
-   * // Setup
-   * const config = PerpetualDataHandler.readSDKConfig("testnet");
-   * let mktData = new MarketData(config);
-   * await mktData.createProxyInstance();
-   * // Get position risk info
-   * let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-   *     "ETH-USD-MATIC");
-   * @example
    * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
    * async function main() {
    *   console.log(MarketData);

package/src/perpetualDataHandler.ts

@@ -502,8 +502,7 @@ export default class PerpetualDataHandler {
 
     let iDeadline = order.deadline == undefined ? Date.now() / 1000 + ORDER_MAX_DURATION_SEC : order.deadline;
     let fTriggerPrice = order.stopPrice == undefined ? BigNumber.from(0) : floatToABK64x64(order.stopPrice);
-    if (order.reduceOnly != undefined && order.reduceOnly == true) {
-    }
+
     let smOrder: SmartContractOrder = {
       flags: flags,
       iPerpetualId: BigNumber.from(perpetualId),
@@ -547,6 +546,7 @@ export default class PerpetualDataHandler {
    */
   private static _orderTypeToFlag(order: Order): BigNumber {
     let flag: BigNumber;
+    order.type = order.type.toUpperCase();
     switch (order.type) {
       case ORDER_TYPE_LIMIT:
         flag = MASK_LIMIT_ORDER;
@@ -579,7 +579,7 @@ export default class PerpetualDataHandler {
     if ((order.type == ORDER_TYPE_MARKET || order.type == ORDER_TYPE_LIMIT) && order.stopPrice != undefined) {
       throw Error(`Order type ${order.type} has no trigger price.`);
     }
-    if (order.type != ORDER_TYPE_MARKET && order.stopPrice != undefined) {
+    if (order.type != ORDER_TYPE_STOP_LIMIT && order.type != ORDER_TYPE_STOP_MARKET && order.stopPrice != undefined) {
       throw Error(`Order type ${order.type} has no trigger price.`);
     }
     return flag;

package/src/writeAccessHandler.ts

@@ -31,12 +31,17 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
   }
 
   /**
-   * Initialize the AccountTrade-Class with this function
+   * Initialize the writeAccessHandler-Class with this function
    * to create instance of D8X perpetual contract and gather information
    * about perpetual currencies
+   * @param provider optional provider
    */
-  public async createProxyInstance() {
-    this.provider = new ethers.providers.JsonRpcProvider(this.nodeURL);
+  public async createProxyInstance(provider?: ethers.providers.JsonRpcProvider) {
+    if (provider == undefined) {
+      this.provider = new ethers.providers.JsonRpcProvider(this.nodeURL);
+    } else {
+      this.provider = provider;
+    }
     const wallet = new ethers.Wallet(this.privateKey);
     this.signer = wallet.connect(this.provider);
     await this.initContractsAndData(this.signer);