@d8x/perpetuals-sdk 0.0.11 → 0.0.14

package/abi/LimitOrderBook.json

@@ -1,4 +1,20 @@
 [
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "_perpetualManagerAddr",
+                "type": "address"
+            },
+            {
+                "internalType": "uint24",
+                "name": "_perpetualId",
+                "type": "uint24"
+            }
+        ],
+        "stateMutability": "nonpayable",
+        "type": "constructor"
+    },
     {
         "anonymous": false,
         "inputs": [
@@ -486,24 +502,6 @@
         "stateMutability": "view",
         "type": "function"
     },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "_perpetualManagerAddr",
-                "type": "address"
-            },
-            {
-                "internalType": "uint24",
-                "name": "_perpetualId",
-                "type": "uint24"
-            }
-        ],
-        "name": "initialize",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
     {
         "inputs": [],
         "name": "lastOrderHash",

package/abi/LimitOrderBookFactory.json

@@ -1,15 +1,4 @@
 [
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "_initImplementation",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "nonpayable",
-        "type": "constructor"
-    },
     {
         "anonymous": false,
         "inputs": [
@@ -54,19 +43,6 @@
         "name": "PerpetualLimitOrderBookDeployed",
         "type": "event"
     },
-    {
-        "inputs": [],
-        "name": "beacon",
-        "outputs": [
-            {
-                "internalType": "contract LimitOrderBookBeacon",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
     {
         "inputs": [
             {
@@ -85,32 +61,6 @@
         "stateMutability": "nonpayable",
         "type": "function"
     },
-    {
-        "inputs": [],
-        "name": "getBeacon",
-        "outputs": [
-            {
-                "internalType": "address",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "getImplementation",
-        "outputs": [
-            {
-                "internalType": "address",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
     {
         "inputs": [
             {

package/config/defaultConfig.json

@@ -3,7 +3,7 @@
   "proxyAddr": "0x44Ae67695781209ace41c422dCfD29d3C678AF68",
   "nodeURL": "https://rpc-mumbai.maticvigil.com/",
   "proxyABILocation": "../abi/IPerpetualManager.json",
-  "limitOrderBookFactoryAddr": "0x209594B4511b36a6D64EBd7798f8b89674B5B230",
+  "limitOrderBookFactoryAddr": "0x5D9Af75B450be534d57106c817145f4E373069cb",
   "limitOrderBookFactoryABILocation": "../abi/LimitOrderBookFactory.json",
   "limitOrderBookABILocation": "../abi/LimitOrderBook.json"
 }

package/dist/accountTrade.d.ts

@@ -37,7 +37,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * 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)
+     *    // 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);
@@ -59,7 +59,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * 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)
+     *    // 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);
@@ -84,7 +84,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * 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)
+     *    // 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);
@@ -121,7 +121,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * 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)
+     *   // 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);
@@ -143,7 +143,7 @@ export default class AccountTrade extends WriteAccessHandler {
      * 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)
+     *   // 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);
@@ -160,6 +160,21 @@ export default class AccountTrade extends WriteAccessHandler {
     /**
      *
      * @param symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * 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();
+     *
      * @returns {string[]} Array of Ids for all the orders currently open by this trader.
      */
     getOrderIds(symbol: string): Promise<string[]>;

package/dist/accountTrade.js

@@ -56,7 +56,7 @@ class AccountTrade extends writeAccessHandler_1.default {
      * 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)
+     *    // 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);
@@ -92,7 +92,7 @@ class AccountTrade extends writeAccessHandler_1.default {
      * 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)
+     *    // 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);
@@ -117,7 +117,7 @@ class AccountTrade extends writeAccessHandler_1.default {
      * 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)
+     *    // 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);
@@ -169,7 +169,7 @@ class AccountTrade extends writeAccessHandler_1.default {
      * 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)
+     *   // 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);
@@ -203,7 +203,7 @@ class AccountTrade extends writeAccessHandler_1.default {
      * 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)
+     *   // 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);
@@ -229,6 +229,21 @@ class AccountTrade extends writeAccessHandler_1.default {
     /**
      *
      * @param symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * 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();
+     *
      * @returns {string[]} Array of Ids for all the orders currently open by this trader.
      */
     getOrderIds(symbol) {

package/dist/brokerTool.d.ts

@@ -1,6 +1,6 @@
 import WriteAccessHandler from "./writeAccessHandler";
-import { NodeSDKConfig, Order, PerpetualStaticInfo } from "./nodeSDKTypes";
-import { BigNumber, ethers } from "ethers";
+import { NodeSDKConfig, Order } from "./nodeSDKTypes";
+import { ethers } from "ethers";
 /**
  * Functions for brokers to determine fees, deposit lots, and sign-up traders.
  * This class requires a private key and executes smart-contract interactions that
@@ -37,7 +37,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -61,7 +61,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -84,7 +84,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -107,7 +107,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -132,21 +132,22 @@ export default class BrokerTool extends WriteAccessHandler {
      * specify symbol, side, type and quantity.
      * @param {string} traderAddr Address of the trader for whom to determine the fee.
      * @example
-     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * import { BrokerTool, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
      *   await brokTool.createProxyInstance();
      *   // get exchange fee based on an order and trader
-     *   let order = {symbol: "ETH-USD-MATIC",
+     *   let order: Order = {
+     *       symbol: "MATIC-USD-MATIC",
      *       side: "BUY",
      *       type: "MARKET",
-     *       quantity: 1,
+     *       quantity: 100,
      *       timestamp: Date.now()
-     *    };
+     *   };
      *    let exchFee = await brokTool.determineExchangeFee(order,
      *        "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
      *   console.log(exchFee);
@@ -164,7 +165,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -186,7 +187,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -208,7 +209,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -230,7 +231,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -257,7 +258,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -272,6 +273,9 @@ export default class BrokerTool extends WriteAccessHandler {
      *    let signedOrder = await brokTool.signOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
      *        0.0001, 1669723339);
      *   console.log(signedOrder);
+     *   // execute order
+     *   let orderTransaction = await accTrade.order(signedOrder);
+     *   console.log(orderTransaction.hash);
      * }
      * main();
      *
@@ -289,13 +293,28 @@ export default class BrokerTool extends WriteAccessHandler {
      * @ignore
      */
     createSignatureForTrader(traderAddr: string, symbol: string, brokerFee: number, deadline: number): Promise<string>;
-    static _signOrder(symbol: string, brokerFeeTbps: number, traderAddr: string, iDeadline: BigNumber, signer: ethers.Wallet, chainId: number, proxyAddress: string, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>): Promise<string>;
+    private static _signOrder;
     /**
      * Transfer ownership of a broker's status to a new wallet. This function transfers the values related to
      * (i) trading volume and (ii) deposited lots to newAddress. The broker needs in addition to manually transfer
      * his D8X holdings to newAddress. Until this transfer is completed, the broker will not have his current designation reflected at newAddress.
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
      * @param {string} newAddress The address this broker wants to use from now on.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // 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 brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // transfer ownership
+     *   let respTransferOwnership = await brokTool.transferOwnership("MATIC", "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(respTransferOwnership);
+     * }
+     * main();
+     *
      * @returns {ethers.providers.TransactionResponse} ethers transaction object
      */
     transferOwnership(poolSymbolName: string, newAddress: string): Promise<ethers.providers.TransactionResponse>;

package/dist/brokerTool.js

@@ -56,7 +56,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -93,7 +93,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -115,6 +115,7 @@ class BrokerTool extends writeAccessHandler_1.default {
             let brokerDesignation;
             if (typeof lots == "undefined") {
                 brokerDesignation = yield this.getBrokerDesignation(poolSymbolName);
+                brokerDesignation = brokerDesignation > 0 ? brokerDesignation : 0;
             }
             else {
                 brokerDesignation = lots;
@@ -132,7 +133,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -164,7 +165,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -200,21 +201,22 @@ class BrokerTool extends writeAccessHandler_1.default {
      * specify symbol, side, type and quantity.
      * @param {string} traderAddr Address of the trader for whom to determine the fee.
      * @example
-     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * import { BrokerTool, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
      *   await brokTool.createProxyInstance();
      *   // get exchange fee based on an order and trader
-     *   let order = {symbol: "ETH-USD-MATIC",
+     *   let order: Order = {
+     *       symbol: "MATIC-USD-MATIC",
      *       side: "BUY",
      *       type: "MARKET",
-     *       quantity: 1,
+     *       quantity: 100,
      *       timestamp: Date.now()
-     *    };
+     *   };
      *    let exchFee = await brokTool.determineExchangeFee(order,
      *        "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
      *   console.log(exchFee);
@@ -242,7 +244,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -274,7 +276,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -306,7 +308,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -337,7 +339,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -374,7 +376,7 @@ class BrokerTool extends writeAccessHandler_1.default {
      * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
      * async function main() {
      *   console.log(BrokerTool);
-     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   // 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 brokTool = new BrokerTool(config, pk);
@@ -389,6 +391,9 @@ class BrokerTool extends writeAccessHandler_1.default {
      *    let signedOrder = await brokTool.signOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
      *        0.0001, 1669723339);
      *   console.log(signedOrder);
+     *   // execute order
+     *   let orderTransaction = await accTrade.order(signedOrder);
+     *   console.log(orderTransaction.hash);
      * }
      * main();
      *
@@ -401,8 +406,8 @@ class BrokerTool extends writeAccessHandler_1.default {
             }
             order.brokerAddr = this.traderAddr;
             order.brokerFeeTbps = brokerFee * 100000;
-            order.deadline = deadline;
-            order.brokerSignature = yield BrokerTool._signOrder(order.symbol, order.brokerFeeTbps, traderAddr, ethers_1.BigNumber.from(deadline), this.signer, this.chainId, this.proxyAddr, this.symbolToPerpStaticInfo);
+            order.deadline = Math.round(deadline);
+            order.brokerSignature = yield BrokerTool._signOrder(order.symbol, order.brokerFeeTbps, traderAddr, ethers_1.BigNumber.from(Math.round(deadline)), this.signer, this.chainId, this.proxyAddr, this.symbolToPerpStaticInfo);
             return order;
         });
     }
@@ -448,6 +453,21 @@ class BrokerTool extends writeAccessHandler_1.default {
      * his D8X holdings to newAddress. Until this transfer is completed, the broker will not have his current designation reflected at newAddress.
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
      * @param {string} newAddress The address this broker wants to use from now on.
+     * @example
+     * import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(BrokerTool);
+     *   // 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 brokTool = new BrokerTool(config, pk);
+     *   await brokTool.createProxyInstance();
+     *   // transfer ownership
+     *   let respTransferOwnership = await brokTool.transferOwnership("MATIC", "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(respTransferOwnership);
+     * }
+     * main();
+     *
      * @returns {ethers.providers.TransactionResponse} ethers transaction object
      */
     transferOwnership(poolSymbolName, newAddress) {

package/dist/marketData.js

@@ -346,8 +346,6 @@ class MarketData extends perpetualDataHandler_1.default {
                         collToQuoteIndexPrice: indexS3,
                         markPrice: indexS2 * (1 + markPremiumRate),
                         currentFundingRateBps: currentFundingRateBps,
-                        initialMarginRate: (0, d8XMath_1.ABK64x64ToFloat)(perp.fInitialMarginRate),
-                        maintenanceMarginRate: (0, d8XMath_1.ABK64x64ToFloat)(perp.fMaintenanceMarginRate),
                         openInterestBC: (0, d8XMath_1.ABK64x64ToFloat)(perp.fOpenInterest),
                         maxPositionBC: (0, d8XMath_1.ABK64x64ToFloat)(perp.fMaxPositionBC),
                     };

package/dist/nodeSDKTypes.d.ts

@@ -65,6 +65,7 @@ export interface PoolStaticInfo {
 export interface PerpetualStaticInfo {
     id: number;
     limitOrderBookAddr: string;
+    initialMarginRate: number;
     maintenanceMarginRate: number;
     collateralCurrencyType: CollaterlCCY;
     S2Symbol: string;
@@ -116,8 +117,6 @@ export interface PerpetualState {
     collToQuoteIndexPrice: number;
     markPrice: number;
     currentFundingRateBps: number;
-    initialMarginRate: number;
-    maintenanceMarginRate: number;
     openInterestBC: number;
     maxPositionBC: number;
 }