@d8x/perpetuals-sdk 0.0.3 → 0.0.4

package/README.md

@@ -15,3 +15,10 @@ Node TypeScript SDK for D8X Perpetual Futures
 ### Test
 
 `npm test`
+
+### NPM Package Deployment
+
+`npm run build`
+`npm login`
+increase version via `npm version patch`
+`npm publish`

package/dist/accountTrade.d.ts

@@ -22,9 +22,9 @@ export default class AccountTrade extends WriteAccessHandler {
     /**
      * Submits an order to the exchange.
      * @param {Order} order Order struct.
-     * @returns {string} Transaction hash.
+     * @returns {ContractTransaction} Contract Transaction (containing events).
      */
-    order(order: Order): Promise<string | undefined>;
+    order(order: Order): Promise<ethers.ContractTransaction>;
     /**
      * 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).
@@ -55,7 +55,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * @returns transaction hash
      * @ignore
      */
-    _order(order: Order, traderAddr: string, symbolToPerpetualMap: Map<string, PerpetualStaticInfo>, proxyContract: ethers.Contract, orderBookContract: ethers.Contract | null, chainId: number, signer: ethers.Wallet, gasLimit: number): Promise<string | undefined>;
+    _order(order: Order, traderAddr: string, symbolToPerpetualMap: Map<string, PerpetualStaticInfo>, proxyContract: ethers.Contract, orderBookContract: ethers.Contract | null, chainId: number, signer: ethers.Wallet, gasLimit: number): Promise<ethers.ContractTransaction>;
     protected _cancelOrder(symbol: string, orderId: string, orderBookContract: ethers.Contract | null): Promise<string | undefined>;
     /**
      * Creates a signature

package/dist/accountTrade.js

@@ -53,7 +53,7 @@ class AccountTrade extends writeAccessHandler_1.default {
     /**
      * Submits an order to the exchange.
      * @param {Order} order Order struct.
-     * @returns {string} Transaction hash.
+     * @returns {ContractTransaction} Contract Transaction (containing events).
      */
     order(order) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -136,7 +136,7 @@ class AccountTrade extends writeAccessHandler_1.default {
                 let signature = yield this._createSignature(scOrder, chainId, true, signer, proxyContract.address);
                 tx = yield orderBookContract.createLimitOrder(scOrder, signature, { gasLimit: gasLimit });
             }
-            return tx.hash;
+            return tx;
         });
     }
     _cancelOrder(symbol, orderId, orderBookContract) {

package/dist/brokerTool.d.ts

@@ -80,9 +80,9 @@ export default class BrokerTool extends WriteAccessHandler {
      * Deposit lots to the default fund of a given pool.
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
      * @param {number} lots Number of lots to deposit into this pool.
-     * @returns {ethers.providers.TransactionResponse} Transaction object.
+     * @returns {ethers.ContractTransaction} ContractTransaction object.
      */
-    brokerDepositToDefaultFund(poolSymbolName: string, lots: number): Promise<ethers.providers.TransactionResponse>;
+    brokerDepositToDefaultFund(poolSymbolName: string, lots: number): Promise<ethers.ContractTransaction>;
     /**
      * Adds this broker's signature to an order so that it can be submitted by an approved trader.
      * @param {Order} order Order to sign.

package/dist/brokerTool.js

@@ -183,7 +183,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * Deposit lots to the default fund of a given pool.
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
      * @param {number} lots Number of lots to deposit into this pool.
-     * @returns {ethers.providers.TransactionResponse} Transaction object.
+     * @returns {ethers.ContractTransaction} ContractTransaction object.
      */
     brokerDepositToDefaultFund(poolSymbolName, lots) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/liquidityProviderTool.d.ts

@@ -28,7 +28,7 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
      * @param {number} amountCC  Amount in pool-collateral currency
      * @return Transaction object
      */
-    addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.providers.TransactionResponse>;
+    addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.ContractTransaction>;
     /**
      * Remove liquidity from the pool.
      * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).

package/dist/marketData.d.ts

@@ -9,6 +9,11 @@ import { Order } from "./nodeSDKTypes";
 export default class MarketData extends PerpetualDataHandler {
     constructor(config: NodeSDKConfig);
     createProxyInstance(): Promise<void>;
+    /**
+     * Get contract instance. Useful for event listening.
+     * @returns read-only proxy instance
+     */
+    getReadOnlyProxyInstance(): ethers.Contract;
     /**
      * Information about the products traded in the exchange.
      * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
@@ -38,6 +43,19 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns {number} Price of index in given currency.
      */
     getOraclePrice(base: string, quote: string): Promise<number | undefined>;
+    /**
+     * Get the current mark price
+     * @param symbol symbol of the form ETH-USD-MATIC
+     * @returns mark price
+     */
+    getMarkPrice(symbol: string): Promise<number>;
+    /**
+     * get the current price for a given quantity
+     * @param symbol symbol of the form ETH-USD-MATIC
+     * @param quantity quantity to be traded, negative if short
+     * @returns price (number)
+     */
+    getPerpetualPrice(symbol: string, quantity: number): Promise<number>;
     /**
      * Query smart contract to get user orders and convert to user friendly order format.
      * @param {string} traderAddr Address of trader.

package/dist/marketData.js

@@ -31,6 +31,16 @@ class MarketData extends perpetualDataHandler_1.default {
             yield this.initContractsAndData(this.provider);
         });
     }
+    /**
+     * Get contract instance. Useful for event listening.
+     * @returns read-only proxy instance
+     */
+    getReadOnlyProxyInstance() {
+        if (this.proxyContract == null) {
+            throw Error("no proxy contract initialized. Use createProxyInstance().");
+        }
+        return this.proxyContract;
+    }
     /**
      * Information about the products traded in the exchange.
      * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
@@ -90,6 +100,33 @@ class MarketData extends perpetualDataHandler_1.default {
             return px == undefined ? undefined : (0, d8XMath_1.ABK64x64ToFloat)(px);
         });
     }
+    /**
+     * Get the current mark price
+     * @param symbol symbol of the form ETH-USD-MATIC
+     * @returns mark price
+     */
+    getMarkPrice(symbol) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            return yield perpetualDataHandler_1.default._queryPerpetualMarkPrice(symbol, this.symbolToPerpStaticInfo, this.proxyContract);
+        });
+    }
+    /**
+     * get the current price for a given quantity
+     * @param symbol symbol of the form ETH-USD-MATIC
+     * @param quantity quantity to be traded, negative if short
+     * @returns price (number)
+     */
+    getPerpetualPrice(symbol, quantity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            return yield perpetualDataHandler_1.default._queryPerpetualPrice(symbol, quantity, this.symbolToPerpStaticInfo, this.proxyContract);
+        });
+    }
     /**
      * Query smart contract to get user orders and convert to user friendly order format.
      * @param {string} traderAddr Address of trader.

package/dist/nodeSDKTypes.d.ts

@@ -9,6 +9,7 @@ export declare const COLLATERAL_CURRENCY_BASE = 1;
 export declare const COLLATERAL_CURRENCY_QUANTO = 2;
 export declare const PERP_STATE_STR: string[];
 export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const ZERO_ORDER_ID = "0x0000000000000000000000000000000000000000000000000000000000000000";
 export declare const ONE_64x64: BigNumber;
 export declare const MAX_64x64: BigNumber;
 export declare const MAX_UINT_256: BigNumber;

package/dist/nodeSDKTypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollaterlCCY = exports.CLOSED_SIDE = exports.SELL_SIDE = exports.BUY_SIDE = exports.ORDER_TYPE_STOP_LIMIT = exports.ORDER_TYPE_STOP_MARKET = exports.ORDER_TYPE_MARKET = exports.ORDER_TYPE_LIMIT = exports.MASK_KEEP_POS_LEVERAGE = exports.MASK_STOP_ORDER = exports.MASK_MARKET_ORDER = exports.MASK_LIMIT_ORDER = exports.MASK_CLOSE_ONLY = exports.ORDER_MAX_DURATION_SEC = exports.DECIMALS = exports.MAX_UINT_256 = exports.MAX_64x64 = exports.ONE_64x64 = exports.ZERO_ADDRESS = exports.PERP_STATE_STR = exports.COLLATERAL_CURRENCY_QUANTO = exports.COLLATERAL_CURRENCY_BASE = exports.COLLATERAL_CURRENCY_QUOTE = exports.ERC20_ABI = exports.DEFAULT_CONFIG_MAINNET_NAME = exports.DEFAULT_CONFIG_TESTNET_NAME = exports.DEFAULT_CONFIG_MAINNET = exports.DEFAULT_CONFIG_TESTNET = void 0;
+exports.CollaterlCCY = exports.CLOSED_SIDE = exports.SELL_SIDE = exports.BUY_SIDE = exports.ORDER_TYPE_STOP_LIMIT = exports.ORDER_TYPE_STOP_MARKET = exports.ORDER_TYPE_MARKET = exports.ORDER_TYPE_LIMIT = exports.MASK_KEEP_POS_LEVERAGE = exports.MASK_STOP_ORDER = exports.MASK_MARKET_ORDER = exports.MASK_LIMIT_ORDER = exports.MASK_CLOSE_ONLY = exports.ORDER_MAX_DURATION_SEC = exports.DECIMALS = exports.MAX_UINT_256 = exports.MAX_64x64 = exports.ONE_64x64 = exports.ZERO_ORDER_ID = exports.ZERO_ADDRESS = exports.PERP_STATE_STR = exports.COLLATERAL_CURRENCY_QUANTO = exports.COLLATERAL_CURRENCY_BASE = exports.COLLATERAL_CURRENCY_QUOTE = exports.ERC20_ABI = exports.DEFAULT_CONFIG_MAINNET_NAME = exports.DEFAULT_CONFIG_TESTNET_NAME = exports.DEFAULT_CONFIG_MAINNET = exports.DEFAULT_CONFIG_TESTNET = void 0;
 const ethers_1 = require("ethers");
 exports.DEFAULT_CONFIG_TESTNET = "../config/defaultConfig.json";
 exports.DEFAULT_CONFIG_MAINNET = "notthereyet";
@@ -11,7 +11,8 @@ exports.COLLATERAL_CURRENCY_QUOTE = 0;
 exports.COLLATERAL_CURRENCY_BASE = 1;
 exports.COLLATERAL_CURRENCY_QUANTO = 2;
 exports.PERP_STATE_STR = ["INVALID", "INITIALIZING", "NORMAL", "EMERGENCY", "CLEARED"];
-exports.ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+exports.ZERO_ADDRESS = ethers_1.constants.AddressZero;
+exports.ZERO_ORDER_ID = ethers_1.constants.HashZero;
 exports.ONE_64x64 = ethers_1.BigNumber.from("0x010000000000000000");
 exports.MAX_64x64 = ethers_1.BigNumber.from("0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");
 exports.MAX_UINT_256 = ethers_1.BigNumber.from(2).pow(256).sub(ethers_1.BigNumber.from(1));

package/dist/orderReferrerTool.d.ts

@@ -19,7 +19,7 @@ export default class OrderReferrerTool extends WriteAccessHandler {
      * if different from the one submitting this transaction.
      * @returns Transaction object.
      */
-    executeOrder(symbol: string, orderId: string, referrerAddr?: string): Promise<ethers.providers.TransactionResponse>;
+    executeOrder(symbol: string, orderId: string, referrerAddr?: string): Promise<ethers.ContractTransaction>;
     /**
      * All the orders in the order book for a given symbol that are currently open.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
@@ -32,6 +32,13 @@ export default class OrderReferrerTool extends WriteAccessHandler {
      * @returns {number} Number of open orders.
      */
     numberOfOpenOrders(symbol: string): Promise<number>;
+    /**
+     * Get order from the digest (=id)
+     * @param symbol symbol of order book, e.g. ETH-USD-MATIC
+     * @param digest digest of the order (=order ID)
+     * @returns order or undefined
+     */
+    getOrderById(symbol: string, id: string): Promise<Order | undefined>;
     /**
      * Get a list of active conditional orders in the order book.
      * This a read-only action and does not incur in gas costs.
@@ -41,5 +48,10 @@ export default class OrderReferrerTool extends WriteAccessHandler {
      * @returns Array of orders and corresponding order IDs
      */
     pollLimitOrders(symbol: string, numElements: number, startAfter?: string): Promise<[Order[], string[]]>;
+    /**
+     * Check if a conditional order can be executed
+     * @param order order structure
+     * @returns true if order can be executed for the current state of the perpetuals
+     */
     isTradeable(order: Order): Promise<boolean>;
 }

package/dist/orderReferrerTool.js

@@ -14,7 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
 const nodeSDKTypes_1 = require("./nodeSDKTypes");
-const ethers_1 = require("ethers");
 /**
  * Methods to execute existing orders from the limit order book.
  */
@@ -72,6 +71,23 @@ class OrderReferrerTool extends writeAccessHandler_1.default {
             return yield orderBookSC.numberOfOrderBookDigests();
         });
     }
+    /**
+     * Get order from the digest (=id)
+     * @param symbol symbol of order book, e.g. ETH-USD-MATIC
+     * @param digest digest of the order (=order ID)
+     * @returns order or undefined
+     */
+    getOrderById(symbol, id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let ob = yield this.getOrderBookContract(symbol);
+            let smartContractOrder = yield ob.orderOfDigest(id);
+            if (smartContractOrder.traderAddr == nodeSDKTypes_1.ZERO_ADDRESS) {
+                return undefined;
+            }
+            let order = OrderReferrerTool.fromSmartContractOrder(smartContractOrder, this.symbolToPerpStaticInfo);
+            return order;
+        });
+    }
     /**
      * Get a list of active conditional orders in the order book.
      * This a read-only action and does not incur in gas costs.
@@ -86,7 +102,7 @@ class OrderReferrerTool extends writeAccessHandler_1.default {
                 throw Error("no proxy contract initialized. Use createProxyInstance().");
             }
             if (typeof startAfter == "undefined") {
-                startAfter = ethers_1.ethers.constants.HashZero;
+                startAfter = nodeSDKTypes_1.ZERO_ORDER_ID;
             }
             const orderBookSC = this.getOrderBookContract(symbol);
             let [orders, orderIds] = yield orderBookSC.pollLimitOrders(startAfter, numElements);
@@ -99,6 +115,11 @@ class OrderReferrerTool extends writeAccessHandler_1.default {
             return [userFriendlyOrders, orderIds];
         });
     }
+    /**
+     * Check if a conditional order can be executed
+     * @param order order structure
+     * @returns true if order can be executed for the current state of the perpetuals
+     */
     isTradeable(order) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.proxyContract == null) {
@@ -108,7 +129,7 @@ class OrderReferrerTool extends writeAccessHandler_1.default {
                 throw Error("order does not have a limit price");
             }
             // check expiration date
-            if (order.deadline != undefined && order.deadline < Date.now()) {
+            if (order.deadline != undefined && order.deadline < Date.now() / 1000) {
                 return false;
             }
             // check limit price

package/dist/perpetualDataHandler.js

@@ -229,7 +229,7 @@ class PerpetualDataHandler {
         return __awaiter(this, void 0, void 0, function* () {
             let perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo);
             let ammState = yield _proxyContract.getAMMState(perpId);
-            return (0, d8XMath_1.ABK64x64ToFloat)(ammState[6].mul(nodeSDKTypes_1.ONE_64x64.add(ammState[8])));
+            return (0, d8XMath_1.ABK64x64ToFloat)(ammState[6].mul(nodeSDKTypes_1.ONE_64x64.add(ammState[8])).div(nodeSDKTypes_1.ONE_64x64));
         });
     }
     /**

package/dist/writeAccessHandler.d.ts

@@ -29,8 +29,8 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
      * 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)
      * @param amount optional, amount to approve if not 'infinity'
-     * @returns transaction hash
+     * @returns ContractTransaction
      */
-    setAllowance(symbol: string, amount?: number | undefined): Promise<string>;
-    protected static _setAllowance(tokenAddr: string, proxyAddr: string, signer: ethers.Wallet, amount: BigNumber): Promise<string>;
+    setAllowance(symbol: string, amount?: number | undefined): Promise<ethers.ContractTransaction>;
+    protected static _setAllowance(tokenAddr: string, proxyAddr: string, signer: ethers.Wallet, amount: BigNumber): Promise<ethers.ContractTransaction>;
 }

package/dist/writeAccessHandler.js

@@ -59,7 +59,7 @@ class WriteAccessHandler extends perpetualDataHandler_1.default {
      * 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)
      * @param amount optional, amount to approve if not 'infinity'
-     * @returns transaction hash
+     * @returns ContractTransaction
      */
     setAllowance(symbol, amount = undefined) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -87,8 +87,7 @@ class WriteAccessHandler extends perpetualDataHandler_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             const marginToken = new ethers_1.ethers.Contract(tokenAddr, nodeSDKTypes_1.ERC20_ABI, signer);
             let tx = yield marginToken.approve(proxyAddr, amount);
-            yield tx.wait();
-            return tx.hash;
+            return tx;
         });
     }
 }

package/package.json

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

package/src/accountTrade.ts

@@ -49,9 +49,9 @@ export default class AccountTrade extends WriteAccessHandler {
   /**
    * Submits an order to the exchange.
    * @param {Order} order Order struct.
-   * @returns {string} Transaction hash.
+   * @returns {ContractTransaction} Contract Transaction (containing events).
    */
-  public async order(order: Order): Promise<string | undefined> {
+  public async order(order: Order): Promise<ethers.ContractTransaction> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -129,11 +129,11 @@ export default class AccountTrade extends WriteAccessHandler {
     chainId: number,
     signer: ethers.Wallet,
     gasLimit: number
-  ): Promise<string | undefined> {
+  ): Promise<ethers.ContractTransaction> {
     let scOrder = AccountTrade.toSmartContractOrder(order, traderAddr, symbolToPerpetualMap);
     // if we are here, we have a clean order
     // decide whether to send order to Limit Order Book or AMM based on order type
-    let tx: ethers.Transaction;
+    let tx: ethers.ContractTransaction;
     if (order.type == ORDER_TYPE_MARKET) {
       // send market order
       tx = await proxyContract.trade(scOrder, { gasLimit: gasLimit });
@@ -145,7 +145,7 @@ export default class AccountTrade extends WriteAccessHandler {
       let signature = await this._createSignature(scOrder, chainId, true, signer, proxyContract.address);
       tx = await orderBookContract.createLimitOrder(scOrder, signature, { gasLimit: gasLimit });
     }
-    return tx.hash;
+    return tx;
   }
 
   protected async _cancelOrder(

package/src/brokerTool.ts

@@ -165,12 +165,9 @@ export default class BrokerTool extends WriteAccessHandler {
    * Deposit lots to the default fund of a given pool.
    * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
    * @param {number} lots Number of lots to deposit into this pool.
-   * @returns {ethers.providers.TransactionResponse} Transaction object.
+   * @returns {ethers.ContractTransaction} ContractTransaction object.
    */
-  public async brokerDepositToDefaultFund(
-    poolSymbolName: string,
-    lots: number
-  ): Promise<ethers.providers.TransactionResponse> {
+  public async brokerDepositToDefaultFund(poolSymbolName: string, lots: number): Promise<ethers.ContractTransaction> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }

package/src/liquidityProviderTool.ts

@@ -59,7 +59,7 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
    * @param {number} amountCC  Amount in pool-collateral currency
    * @return Transaction object
    */
-  public async addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.providers.TransactionResponse> {
+  public async addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.ContractTransaction> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }

package/src/marketData.ts

@@ -29,6 +29,17 @@ export default class MarketData extends PerpetualDataHandler {
     await this.initContractsAndData(this.provider);
   }
 
+  /**
+   * Get contract instance. Useful for event listening.
+   * @returns read-only proxy instance
+   */
+  public getReadOnlyProxyInstance(): ethers.Contract {
+    if (this.proxyContract == null) {
+      throw Error("no proxy contract initialized. Use createProxyInstance().");
+    }
+    return this.proxyContract;
+  }
+
   /**
    * Information about the products traded in the exchange.
    * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
@@ -89,6 +100,36 @@ export default class MarketData extends PerpetualDataHandler {
     return px == undefined ? undefined : ABK64x64ToFloat(px);
   }
 
+  /**
+   * Get the current mark price
+   * @param symbol symbol of the form ETH-USD-MATIC
+   * @returns mark price
+   */
+  public async getMarkPrice(symbol: string): Promise<number> {
+    if (this.proxyContract == null) {
+      throw Error("no proxy contract initialized. Use createProxyInstance().");
+    }
+    return await PerpetualDataHandler._queryPerpetualMarkPrice(symbol, this.symbolToPerpStaticInfo, this.proxyContract);
+  }
+
+  /**
+   * get the current price for a given quantity
+   * @param symbol symbol of the form ETH-USD-MATIC
+   * @param quantity quantity to be traded, negative if short
+   * @returns price (number)
+   */
+  public async getPerpetualPrice(symbol: string, quantity: number): Promise<number> {
+    if (this.proxyContract == null) {
+      throw Error("no proxy contract initialized. Use createProxyInstance().");
+    }
+    return await PerpetualDataHandler._queryPerpetualPrice(
+      symbol,
+      quantity,
+      this.symbolToPerpStaticInfo,
+      this.proxyContract
+    );
+  }
+
   /**
    * Query smart contract to get user orders and convert to user friendly order format.
    * @param {string} traderAddr Address of trader.

package/src/nodeSDKTypes.ts

@@ -1,4 +1,4 @@
-import { BytesLike, BigNumber, BigNumberish } from "ethers";
+import { BytesLike, BigNumber, BigNumberish, constants } from "ethers";
 export const DEFAULT_CONFIG_TESTNET = "../config/defaultConfig.json";
 export const DEFAULT_CONFIG_MAINNET = "notthereyet";
 export const DEFAULT_CONFIG_TESTNET_NAME = "testnet";
@@ -9,7 +9,8 @@ export const COLLATERAL_CURRENCY_QUOTE = 0;
 export const COLLATERAL_CURRENCY_BASE = 1;
 export const COLLATERAL_CURRENCY_QUANTO = 2;
 export const PERP_STATE_STR = ["INVALID", "INITIALIZING", "NORMAL", "EMERGENCY", "CLEARED"];
-export const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export const ZERO_ADDRESS = constants.AddressZero;
+export const ZERO_ORDER_ID = constants.HashZero;
 
 export const ONE_64x64 = BigNumber.from("0x010000000000000000");
 export const MAX_64x64 = BigNumber.from("0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");

package/src/orderReferrerTool.ts

@@ -1,5 +1,5 @@
 import WriteAccessHandler from "./writeAccessHandler";
-import { BUY_SIDE, NodeSDKConfig, Order, SELL_SIDE, ZERO_ADDRESS } from "./nodeSDKTypes";
+import { BUY_SIDE, NodeSDKConfig, Order, SELL_SIDE, ZERO_ADDRESS, ZERO_ORDER_ID } from "./nodeSDKTypes";
 import { ethers } from "ethers";
 
 /**
@@ -27,7 +27,7 @@ export default class OrderReferrerTool extends WriteAccessHandler {
     symbol: string,
     orderId: string,
     referrerAddr?: string
-  ): Promise<ethers.providers.TransactionResponse> {
+  ): Promise<ethers.ContractTransaction> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -61,6 +61,22 @@ export default class OrderReferrerTool extends WriteAccessHandler {
     return await orderBookSC.numberOfOrderBookDigests();
   }
 
+  /**
+   * Get order from the digest (=id)
+   * @param symbol symbol of order book, e.g. ETH-USD-MATIC
+   * @param digest digest of the order (=order ID)
+   * @returns order or undefined
+   */
+  public async getOrderById(symbol: string, id: string): Promise<Order | undefined> {
+    let ob = await this.getOrderBookContract(symbol);
+    let smartContractOrder = await ob.orderOfDigest(id);
+    if (smartContractOrder.traderAddr == ZERO_ADDRESS) {
+      return undefined;
+    }
+    let order = OrderReferrerTool.fromSmartContractOrder(smartContractOrder, this.symbolToPerpStaticInfo);
+    return order;
+  }
+
   /**
    * Get a list of active conditional orders in the order book.
    * This a read-only action and does not incur in gas costs.
@@ -74,7 +90,7 @@ export default class OrderReferrerTool extends WriteAccessHandler {
       throw Error("no proxy contract initialized. Use createProxyInstance().");
     }
     if (typeof startAfter == "undefined") {
-      startAfter = ethers.constants.HashZero;
+      startAfter = ZERO_ORDER_ID;
     }
     const orderBookSC = this.getOrderBookContract(symbol);
     let [orders, orderIds] = await orderBookSC.pollLimitOrders(startAfter, numElements);
@@ -87,7 +103,12 @@ export default class OrderReferrerTool extends WriteAccessHandler {
     return [userFriendlyOrders, orderIds];
   }
 
-  public async isTradeable(order: Order) {
+  /**
+   * Check if a conditional order can be executed
+   * @param order order structure
+   * @returns true if order can be executed for the current state of the perpetuals
+   */
+  public async isTradeable(order: Order): Promise<boolean> {
     if (this.proxyContract == null) {
       throw Error("no proxy contract initialized. Use createProxyInstance().");
     }
@@ -95,7 +116,7 @@ export default class OrderReferrerTool extends WriteAccessHandler {
       throw Error("order does not have a limit price");
     }
     // check expiration date
-    if (order.deadline != undefined && order.deadline < Date.now()) {
+    if (order.deadline != undefined && order.deadline < Date.now() / 1000) {
       return false;
     }
     // check limit price

package/src/perpetualDataHandler.ts

@@ -301,7 +301,7 @@ export default class PerpetualDataHandler {
   ): Promise<number> {
     let perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo);
     let ammState = await _proxyContract.getAMMState(perpId);
-    return ABK64x64ToFloat(ammState[6].mul(ONE_64x64.add(ammState[8])));
+    return ABK64x64ToFloat(ammState[6].mul(ONE_64x64.add(ammState[8])).div(ONE_64x64));
   }
 
   /**

package/src/writeAccessHandler.ts

@@ -47,9 +47,12 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
    * 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)
    * @param amount optional, amount to approve if not 'infinity'
-   * @returns transaction hash
+   * @returns ContractTransaction
    */
-  public async setAllowance(symbol: string, amount: number | undefined = undefined): Promise<string> {
+  public async setAllowance(
+    symbol: string,
+    amount: number | undefined = undefined
+  ): Promise<ethers.ContractTransaction> {
     //extract margin-currency name
     let symbolarr = symbol.split("-");
     symbol = symbol.length == 3 ? symbolarr[2] : symbolarr[0];
@@ -74,10 +77,9 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
     proxyAddr: string,
     signer: ethers.Wallet,
     amount: BigNumber
-  ): Promise<string> {
+  ): Promise<ethers.ContractTransaction> {
     const marginToken: ethers.Contract = new ethers.Contract(tokenAddr, ERC20_ABI, signer);
     let tx = await marginToken.approve(proxyAddr, amount);
-    await tx.wait();
-    return tx.hash;
+    return tx;
   }
 }