@d8x/perpetuals-sdk 0.0.25 → 0.0.27

package/dist/apiInterface.d.ts

@@ -2,9 +2,19 @@ import { ethers } from "ethers";
 import MarketData from "./marketData";
 import { NodeSDKConfig, SmartContractOrder, Order } from "./nodeSDKTypes";
 import TraderDigests from "./traderDigests";
+/**
+ * Interface that can be used by front-end that wraps all private functions
+ * so that signatures can be handled in frontend via wallet
+ * @extends MarketData
+ */
 export default class APIInterface extends MarketData {
     protected chainId: number;
     protected digestTool: TraderDigests;
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     */
     constructor(config: NodeSDKConfig);
     /**
      * Initialize the marketData-Class with this function

package/dist/apiInterface.js

@@ -15,11 +15,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const marketData_1 = __importDefault(require("./marketData"));
 const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
 const traderDigests_1 = __importDefault(require("./traderDigests"));
-/*
-   interface that can be used by front-end that wraps all private functions
-   so that signatures can be handled in frontend via wallet
-
-*/
+/**
+ * Interface that can be used by front-end that wraps all private functions
+ * so that signatures can be handled in frontend via wallet
+ * @extends MarketData
+ */
 class APIInterface extends marketData_1.default {
     // accTrade.order(order)
     // cancelOrder(symbol: string, orderId: string)
@@ -27,6 +27,11 @@ class APIInterface extends marketData_1.default {
     // accTrade.queryExchangeFee("MATIC")
     // accTrade.getCurrentTraderVolume("MATIC")
     // accTrade.getOrderIds("MATIC-USD-MATIC")
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     */
     constructor(config) {
         super(config);
         this.chainId = 0;

package/dist/traderInterface.d.ts

@@ -0,0 +1,50 @@
+import { ethers } from "ethers";
+import MarketData from "./marketData";
+import { NodeSDKConfig, SmartContractOrder, Order } from "./nodeSDKTypes";
+import TraderDigests from "./traderDigests";
+/**
+ * Interface that can be used by front-end that wraps all private functions
+ * so that signatures can be handled in frontend via wallet
+ * @extends MarketData
+ */
+export default class TraderInterface extends MarketData {
+    protected chainId: number;
+    protected digestTool: TraderDigests;
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     */
+    constructor(config: NodeSDKConfig);
+    /**
+     * 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 digest to cancel an order. Digest needs to be signed and submitted via
+     * orderBookContract.cancelOrder(orderId, signature);
+     * @param symbol
+     * @param orderId
+     * @returns tuple of digest which the trader needs to sign and address of order book contract
+     */
+    cancelOrderDigest(symbol: string, orderId: string): Promise<{
+        digest: string;
+        OBContractAddr: string;
+    }>;
+    /**
+     * Create smart contract order and digest that the trader signs.
+     * await orderBookContract.postOrder(scOrder, signature, { gasLimit: gasLimit });
+     * Order must contain broker fee and broker address if there is supposed to be a broker.
+     * @param order order struct
+     * @param traderAddr address of the trader
+     * @returns tuple of digest that the trader has to sign, order book address, and smart contract order
+     */
+    orderDigest(order: Order, traderAddr: string): Promise<{
+        digest: string;
+        OBAddr: string;
+        SCOrder: SmartContractOrder;
+    }>;
+}

package/dist/traderInterface.js

@@ -0,0 +1,97 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const marketData_1 = __importDefault(require("./marketData"));
+const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
+const traderDigests_1 = __importDefault(require("./traderDigests"));
+/**
+ * Interface that can be used by front-end that wraps all private functions
+ * so that signatures can be handled in frontend via wallet
+ * @extends MarketData
+ */
+class TraderInterface extends marketData_1.default {
+    // accTrade.order(order)
+    // cancelOrder(symbol: string, orderId: string)
+    // accTrade.setAllowance
+    // accTrade.queryExchangeFee("MATIC")
+    // accTrade.getCurrentTraderVolume("MATIC")
+    // accTrade.getOrderIds("MATIC-USD-MATIC")
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     */
+    constructor(config) {
+        super(config);
+        this.chainId = 0;
+        this.digestTool = new traderDigests_1.default();
+    }
+    /**
+     * 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) {
+        const _super = Object.create(null, {
+            createProxyInstance: { get: () => super.createProxyInstance }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield _super.createProxyInstance.call(this, provider);
+            this.chainId = (yield this.provider.getNetwork()).chainId;
+        });
+    }
+    /**
+     * Get digest to cancel an order. Digest needs to be signed and submitted via
+     * orderBookContract.cancelOrder(orderId, signature);
+     * @param symbol
+     * @param orderId
+     * @returns tuple of digest which the trader needs to sign and address of order book contract
+     */
+    cancelOrderDigest(symbol, orderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            let orderBookContract = this.getOrderBookContract(symbol);
+            let scOrder = yield orderBookContract.orderOfDigest(orderId);
+            let digest = yield this.digestTool.createDigest(scOrder, this.chainId, false, this.proxyAddr);
+            return { digest: digest, OBContractAddr: orderBookContract.address };
+        });
+    }
+    /**
+     * Create smart contract order and digest that the trader signs.
+     * await orderBookContract.postOrder(scOrder, signature, { gasLimit: gasLimit });
+     * Order must contain broker fee and broker address if there is supposed to be a broker.
+     * @param order order struct
+     * @param traderAddr address of the trader
+     * @returns tuple of digest that the trader has to sign, order book address, and smart contract order
+     */
+    orderDigest(order, traderAddr) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+            }
+            let minSize = perpetualDataHandler_1.default._getMinimalPositionSize(order.symbol, this.symbolToPerpStaticInfo);
+            if (Math.abs(order.quantity) < minSize) {
+                throw Error("order size too small");
+            }
+            let orderBookContract = this.getOrderBookContract(order.symbol);
+            let scOrder = TraderInterface.toSmartContractOrder(order, traderAddr, this.symbolToPerpStaticInfo);
+            let digest = yield this.digestTool.createDigest(scOrder, this.chainId, true, this.proxyContract.address);
+            return { digest: digest, OBAddr: orderBookContract.address, SCOrder: scOrder };
+        });
+    }
+}
+exports.default = TraderInterface;

package/package.json

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

package/src/perpetualDataHandler.ts

@@ -48,7 +48,6 @@ import {
   calculateLiquidationPriceCollateralBase,
   calculateLiquidationPriceCollateralQuote,
 } from "./d8XMath";
-import { Config } from "jest";
 
 /**
  * Parent class for MarketData and WriteAccessHandler that handles

package/src/{apiInterface.ts → traderInterface.ts}

@@ -3,13 +3,13 @@ import MarketData from "./marketData";
 import PerpetualDataHandler from "./perpetualDataHandler";
 import { NodeSDKConfig, SmartContractOrder, Order } from "./nodeSDKTypes";
 import TraderDigests from "./traderDigests";
-/*
-   interface that can be used by front-end that wraps all private functions
-   so that signatures can be handled in frontend via wallet
 
-*/
-
-export default class APIInterface extends MarketData {
+/**
+ * Interface that can be used by front-end that wraps all private functions
+ * so that signatures can be handled in frontend via wallet
+ * @extends MarketData
+ */
+export default class TraderInterface extends MarketData {
   protected chainId: number = 0;
   protected digestTool: TraderDigests;
 
@@ -19,7 +19,13 @@ export default class APIInterface extends MarketData {
   // accTrade.queryExchangeFee("MATIC")
   // accTrade.getCurrentTraderVolume("MATIC")
   // accTrade.getOrderIds("MATIC-USD-MATIC")
-  constructor(config: NodeSDKConfig) {
+
+  /**
+   * Constructor
+   * @param {NodeSDKConfig} config Configuration object, see
+   * PerpetualDataHandler.readSDKConfig.
+   */
+  public constructor(config: NodeSDKConfig) {
     super(config);
     this.digestTool = new TraderDigests();
   }
@@ -72,7 +78,7 @@ export default class APIInterface extends MarketData {
       throw Error("order size too small");
     }
     let orderBookContract: ethers.Contract = this.getOrderBookContract(order.symbol);
-    let scOrder = APIInterface.toSmartContractOrder(order, traderAddr, this.symbolToPerpStaticInfo);
+    let scOrder = TraderInterface.toSmartContractOrder(order, traderAddr, this.symbolToPerpStaticInfo);
     let digest = await this.digestTool.createDigest(scOrder, this.chainId, true, this.proxyContract.address);
     return { digest: digest, OBAddr: orderBookContract.address, SCOrder: scOrder };
   }