@d8x/perpetuals-sdk 0.0.4 → 0.0.6

package/abi/IPerpetualManager.json

@@ -1,4 +1,66 @@
 [
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "internalType": "uint8",
+                "name": "poolId",
+                "type": "uint8"
+            },
+            {
+                "indexed": false,
+                "internalType": "address",
+                "name": "oldOwner",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "internalType": "address",
+                "name": "newOwner",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint32",
+                "name": "numLots",
+                "type": "uint32"
+            }
+        ],
+        "name": "BrokerLotsTransferred",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "internalType": "uint8",
+                "name": "poolId",
+                "type": "uint8"
+            },
+            {
+                "indexed": false,
+                "internalType": "address",
+                "name": "oldOwner",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "internalType": "address",
+                "name": "newOwner",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "internalType": "int128",
+                "name": "fVolume",
+                "type": "int128"
+            }
+        ],
+        "name": "BrokerVolumeTransferred",
+        "type": "event"
+    },
     {
         "anonymous": false,
         "inputs": [
@@ -365,6 +427,63 @@
         "name": "SetBrokerCollateralLotSize",
         "type": "event"
     },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint32[]",
+                "name": "designations",
+                "type": "uint32[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint16[]",
+                "name": "fees",
+                "type": "uint16[]"
+            }
+        ],
+        "name": "SetBrokerDesignations",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint256[]",
+                "name": "tiers",
+                "type": "uint256[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint16[]",
+                "name": "feesTbps",
+                "type": "uint16[]"
+            }
+        ],
+        "name": "SetBrokerTiers",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint256[]",
+                "name": "tiers",
+                "type": "uint256[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint16[]",
+                "name": "feesTbps",
+                "type": "uint16[]"
+            }
+        ],
+        "name": "SetBrokerVolumeTiers",
+        "type": "event"
+    },
     {
         "anonymous": false,
         "inputs": [
@@ -604,6 +723,57 @@
         "name": "SetTargetPoolSizeUpdateTime",
         "type": "event"
     },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint256[]",
+                "name": "tiers",
+                "type": "uint256[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint16[]",
+                "name": "feesTbps",
+                "type": "uint16[]"
+            }
+        ],
+        "name": "SetTraderTiers",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint256[]",
+                "name": "tiers",
+                "type": "uint256[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "uint16[]",
+                "name": "feesTbps",
+                "type": "uint16[]"
+            }
+        ],
+        "name": "SetTraderVolumeTiers",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "address",
+                "name": "tokenAddr",
+                "type": "address"
+            }
+        ],
+        "name": "SetUtilityToken",
+        "type": "event"
+    },
     {
         "anonymous": false,
         "inputs": [
@@ -2334,6 +2504,54 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolId",
+                "type": "uint8"
+            },
+            {
+                "internalType": "address",
+                "name": "_brokerAddr",
+                "type": "address"
+            }
+        ],
+        "name": "getCurrentBrokerVolume",
+        "outputs": [
+            {
+                "internalType": "int128",
+                "name": "",
+                "type": "int128"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolId",
+                "type": "uint8"
+            },
+            {
+                "internalType": "address",
+                "name": "_traderAddr",
+                "type": "address"
+            }
+        ],
+        "name": "getCurrentTraderVolume",
+        "outputs": [
+            {
+                "internalType": "int128",
+                "name": "",
+                "type": "int128"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [
             {
@@ -3699,6 +3917,30 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint24",
+                "name": "_iPerpetualId",
+                "type": "uint24"
+            },
+            {
+                "internalType": "int128",
+                "name": "_fTradeAmountBC",
+                "type": "int128"
+            }
+        ],
+        "name": "queryPerpetualPrice",
+        "outputs": [
+            {
+                "internalType": "int128",
+                "name": "",
+                "type": "int128"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [
             {
@@ -3931,6 +4173,29 @@
         "stateMutability": "nonpayable",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolId",
+                "type": "uint8"
+            },
+            {
+                "internalType": "address",
+                "name": "_brokerAddr",
+                "type": "address"
+            },
+            {
+                "internalType": "uint16",
+                "name": "_feeTbps",
+                "type": "uint16"
+            }
+        ],
+        "name": "setInitialVolumeForFee",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
     {
         "inputs": [
             {
@@ -4450,6 +4715,47 @@
         "stateMutability": "nonpayable",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolId",
+                "type": "uint8"
+            },
+            {
+                "internalType": "address",
+                "name": "_transferToAddr",
+                "type": "address"
+            },
+            {
+                "internalType": "uint32",
+                "name": "_lots",
+                "type": "uint32"
+            }
+        ],
+        "name": "transferBrokerLots",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolId",
+                "type": "uint8"
+            },
+            {
+                "internalType": "address",
+                "name": "_transferToAddr",
+                "type": "address"
+            }
+        ],
+        "name": "transferBrokerOwnership",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
     {
         "inputs": [
             {

package/config/defaultConfig.json

@@ -1,9 +1,9 @@
 {
   "name": "v1.1",
-  "proxyAddr": "0x55F4041DAea27c6F380d6E221d63EF300a293Ee5",
+  "proxyAddr": "0x51b05809eF1E84BB963D84ff95FB5E625d88152d",
   "nodeURL": "https://rpc-mumbai.maticvigil.com/",
   "proxyABILocation": "../abi/IPerpetualManager.json",
-  "limitOrderBookFactoryAddr": "0xd63Faf780687795EBac85ce248a45E457752f021",
+  "limitOrderBookFactoryAddr": "0x92B6967Ea9b6A0375013649dBd3d0CD9DceeEf4d",
   "limitOrderBookFactoryABILocation": "../abi/LimitOrderBookFactory.json",
   "limitOrderBookABILocation": "../abi/LimitOrderBook.json"
 }

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 {ContractTransaction} Contract Transaction (containing events).
+     * @returns {string} Transaction hash.
      */
-    order(order: Order): Promise<ethers.ContractTransaction>;
+    order(order: Order): Promise<string | undefined>;
     /**
      * 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<ethers.ContractTransaction>;
+    _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>;
     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 {ContractTransaction} Contract Transaction (containing events).
+     * @returns {string} Transaction hash.
      */
     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;
+            return tx.hash;
         });
     }
     _cancelOrder(symbol, orderId, orderBookContract) {

package/dist/brokerTool.d.ts

@@ -34,7 +34,7 @@ export default class BrokerTool extends WriteAccessHandler {
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC, USDC, etc).
      * @returns {number} Fee based solely on a broker's traded volume in the corresponding pool, in decimals (i.e. 0.1% is 0.001).
      */
-    getFeeForBrokerVolume(poolSymbolName: string): Promise<number>;
+    getFeeForBrokerVolume(poolSymbolName: string): Promise<number | undefined>;
     /**
      * Determine the exchange fee based on the current D8X balance in a broker's wallet.
      * The final exchange fee paid by the broker is equal to
@@ -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.ContractTransaction} ContractTransaction object.
+     * @returns {ethers.providers.TransactionResponse} Transaction object.
      */
-    brokerDepositToDefaultFund(poolSymbolName: string, lots: number): Promise<ethers.ContractTransaction>;
+    brokerDepositToDefaultFund(poolSymbolName: string, lots: number): Promise<ethers.providers.TransactionResponse>;
     /**
      * 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.ContractTransaction} ContractTransaction object.
+     * @returns {ethers.providers.TransactionResponse} Transaction object.
      */
     brokerDepositToDefaultFund(poolSymbolName, lots) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/liquidatorTool.d.ts

@@ -45,8 +45,8 @@ export default class LiquidatorTool extends WriteAccessHandler {
      * Get addresses of active accounts by chunks.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @param {number} from From which account we start counting (0-indexed).
-     * @param {number} to Until which account we count, non inclusive.
-     * @returns {string[]} Array of addresses at locations 'from', 'from'+1 ,..., 'to'-1.
+     * @param {number} to Until which account we count.
+     * @returns {string[]} Array of addresses.
      */
     getActiveAccountsByChunks(symbol: string, from: number, to: number): Promise<string[]>;
     /**

package/dist/liquidatorTool.js

@@ -60,7 +60,7 @@ class LiquidatorTool extends writeAccessHandler_1.default {
                 throw Error("no proxy contract initialized. Use createProxyInstance().");
             }
             let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-            return yield this.proxyContract.isTraderMaintenanceMarginSafe(perpID, traderAddr);
+            return yield this.proxyContract.isMaintenanceMarginSafe(perpID, traderAddr);
         });
     }
     /**
@@ -97,8 +97,8 @@ class LiquidatorTool extends writeAccessHandler_1.default {
      * Get addresses of active accounts by chunks.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @param {number} from From which account we start counting (0-indexed).
-     * @param {number} to Until which account we count, non inclusive.
-     * @returns {string[]} Array of addresses at locations 'from', 'from'+1 ,..., 'to'-1.
+     * @param {number} to Until which account we count.
+     * @returns {string[]} Array of addresses.
      */
     getActiveAccountsByChunks(symbol, from, to) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -117,8 +117,8 @@ class LiquidatorTool extends writeAccessHandler_1.default {
     getAllActiveAccounts(symbol) {
         return __awaiter(this, void 0, void 0, function* () {
             // checks are done inside the intermediate functions
-            let totalAccounts = yield this.countActivePerpAccounts(symbol);
-            return yield this.getActiveAccountsByChunks(symbol, 0, totalAccounts);
+            let totalAccoutns = yield this.countActivePerpAccounts(symbol);
+            return yield this.getActiveAccountsByChunks(symbol, 0, totalAccoutns - 1);
         });
     }
 }

package/dist/liquiditatorTool.d.ts

@@ -0,0 +1,14 @@
+import WriteAccessHandler from "./writeAccessHandler";
+import { NodeSDKConfig } from "./nodeSDKTypes";
+/**
+ * LiquidatorTool
+ * Methods to liquidate traders
+ */
+export default class LiquidatorTool extends WriteAccessHandler {
+    /**
+     * Constructor
+     * @param config configuration
+     * @param privateKey private key of account that trades
+     */
+    constructor(config: NodeSDKConfig, privateKey: string);
+}

package/dist/liquiditatorTool.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
+/**
+ * LiquidatorTool
+ * Methods to liquidate traders
+ */
+class LiquidatorTool extends writeAccessHandler_1.default {
+    /**
+     * Constructor
+     * @param config configuration
+     * @param privateKey private key of account that trades
+     */
+    constructor(config, privateKey) {
+        super(config, privateKey);
+    }
+}
+exports.default = LiquidatorTool;

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.ContractTransaction>;
+    addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.providers.TransactionResponse>;
     /**
      * Remove liquidity from the pool.
      * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).

package/dist/marketData.d.ts

@@ -9,11 +9,6 @@ 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.
@@ -36,26 +31,6 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns {MarginAccount}
      */
     positionRisk(traderAddr: string, symbol: string): Promise<MarginAccount>;
-    /**
-     * Uses the Oracle(s) in the exchange to get the latest price of a given index in a given currency, if a route exists.
-     * @param {string} base Index name, e.g. ETH.
-     * @param {string} quote Quote currency, e.g. USD.
-     * @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,16 +31,6 @@ 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.
@@ -85,48 +75,6 @@ class MarketData extends perpetualDataHandler_1.default {
             return mgnAcct;
         });
     }
-    /**
-     * Uses the Oracle(s) in the exchange to get the latest price of a given index in a given currency, if a route exists.
-     * @param {string} base Index name, e.g. ETH.
-     * @param {string} quote Quote currency, e.g. USD.
-     * @returns {number} Price of index in given currency.
-     */
-    getOraclePrice(base, quote) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.proxyContract == null) {
-                throw Error("no proxy contract initialized. Use createProxyInstance().");
-            }
-            let px = yield this.proxyContract.getOraclePrice([(0, utils_1.toBytes4)(base), (0, utils_1.toBytes4)(quote)]);
-            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,7 +9,6 @@ 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_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;
+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;
 const ethers_1 = require("ethers");
 exports.DEFAULT_CONFIG_TESTNET = "../config/defaultConfig.json";
 exports.DEFAULT_CONFIG_MAINNET = "notthereyet";
@@ -11,8 +11,7 @@ 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 = ethers_1.constants.AddressZero;
-exports.ZERO_ORDER_ID = ethers_1.constants.HashZero;
+exports.ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
 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.ContractTransaction>;
+    executeOrder(symbol: string, orderId: string, referrerAddr?: string): Promise<ethers.providers.TransactionResponse>;
     /**
      * 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,26 +32,14 @@ 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.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @param {number} numElements Maximum number of orders to poll.
      * @param {string=} startAfter Optional order ID from where to start polling. Defaults to the first order.
-     * @returns Array of orders and corresponding order IDs
+     * @returns {[Order[], string[]]} 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

@@ -71,30 +71,13 @@ 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.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
      * @param {number} numElements Maximum number of orders to poll.
      * @param {string=} startAfter Optional order ID from where to start polling. Defaults to the first order.
-     * @returns Array of orders and corresponding order IDs
+     * @returns {[Order[], string[]]} Array of orders and corresponding order IDs
      */
     pollLimitOrders(symbol, numElements, startAfter) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -102,7 +85,7 @@ class OrderReferrerTool extends writeAccessHandler_1.default {
                 throw Error("no proxy contract initialized. Use createProxyInstance().");
             }
             if (typeof startAfter == "undefined") {
-                startAfter = nodeSDKTypes_1.ZERO_ORDER_ID;
+                startAfter = nodeSDKTypes_1.ZERO_ADDRESS;
             }
             const orderBookSC = this.getOrderBookContract(symbol);
             let [orders, orderIds] = yield orderBookSC.pollLimitOrders(startAfter, numElements);
@@ -115,11 +98,6 @@ 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) {
@@ -129,7 +107,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() / 1000) {
+            if (order.deadline != undefined && order.deadline < Date.now()) {
                 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])).div(nodeSDKTypes_1.ONE_64x64));
+            return (0, d8XMath_1.ABK64x64ToFloat)(ammState[6].mul(nodeSDKTypes_1.ONE_64x64.add(ammState[8])));
         });
     }
     /**
@@ -310,20 +310,16 @@ class PerpetualDataHandler {
         // concatenate and find perpetual Id in map
         return symbols[0] + "-" + symbols[1] + "-" + symbols[2];
     }
-    static _getByValue(map, searchValue, valueField) {
+    static _getByValue(map, searchValue) {
         for (let [key, value] of map.entries()) {
-            if (value[valueField] === searchValue) {
+            if (value === searchValue) {
                 return key;
             }
         }
-        return undefined;
     }
     static fromSmartContractOrder(order, symbolToPerpInfoMap) {
         // find symbol of perpetual id
-        let symbol = PerpetualDataHandler._getByValue(symbolToPerpInfoMap, order.iPerpetualId, "id");
-        if (symbol == undefined) {
-            throw Error(`Perpetual id ${order.iPerpetualId} not found. Check with marketData.exchangeInfo().`);
-        }
+        let symbol = PerpetualDataHandler._getByValue(symbolToPerpInfoMap, order.iPerpetualId);
         let side = order.fAmount > 0 ? nodeSDKTypes_1.BUY_SIDE : nodeSDKTypes_1.SELL_SIDE;
         let limitPrice, stopPrice;
         let fLimitPrice = ethers_1.BigNumber.from(order.fLimitPrice);
@@ -348,9 +344,9 @@ class PerpetualDataHandler {
             reduceOnly: (0, utils_1.containsFlag)(ethers_1.BigNumber.from(order.flags), nodeSDKTypes_1.MASK_CLOSE_ONLY),
             limitPrice: limitPrice,
             keepPositionLvg: (0, utils_1.containsFlag)(ethers_1.BigNumber.from(order.flags), nodeSDKTypes_1.MASK_KEEP_POS_LEVERAGE),
-            brokerFeeTbps: order.brokerFeeTbps == 0 ? undefined : Number(order.brokerFeeTbps),
-            brokerAddr: order.brokerAddr == nodeSDKTypes_1.ZERO_ADDRESS ? undefined : order.brokerAddr,
-            brokerSignature: order.brokerSignature == "0x" ? undefined : order.brokerSignature,
+            brokerFeeTbps: Number(order.brokerFeeTbps),
+            brokerAddr: order.brokerAddr,
+            brokerSignature: order.brokerSignature,
             stopPrice: stopPrice,
             leverage: (0, d8XMath_1.ABK64x64ToFloat)(ethers_1.BigNumber.from(order.fLeverage)),
             deadline: Number(order.iDeadline),

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 ContractTransaction
+     * @returns transaction hash
      */
-    setAllowance(symbol: string, amount?: number | undefined): Promise<ethers.ContractTransaction>;
-    protected static _setAllowance(tokenAddr: string, proxyAddr: string, signer: ethers.Wallet, amount: BigNumber): Promise<ethers.ContractTransaction>;
+    setAllowance(symbol: string, amount?: number | undefined): Promise<string>;
+    protected static _setAllowance(tokenAddr: string, proxyAddr: string, signer: ethers.Wallet, amount: BigNumber): Promise<string>;
 }

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 ContractTransaction
+     * @returns transaction hash
      */
     setAllowance(symbol, amount = undefined) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -87,7 +87,8 @@ 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);
-            return tx;
+            yield tx.wait();
+            return tx.hash;
         });
     }
 }

package/package.json

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

package/src/index.ts

@@ -5,6 +5,7 @@ import MarketData from "./marketData";
 import OrderReferrerTool from "./orderReferrerTool";
 import PerpetualDataHandler from "./perpetualDataHandler";
 import WriteAccessHandler from "./writeAccessHandler";
+import LiquidatorTool from "./liquidatorTool";
 // import {
 //   NodeSDKConfig,
 //   MarginAccount,
@@ -29,4 +30,5 @@ export {
   OrderReferrerTool,
   PerpetualDataHandler,
   WriteAccessHandler,
+  LiquidatorTool,
 };