@d8x/perpetuals-sdk 0.0.35 → 0.0.36

package/config/defaultConfig.json

@@ -1,7 +1,7 @@
 {
   "name": "v1.5",
   "proxyAddr": "0xaB6AD25eE5CA28E7d7b16A33A33897aE34BF9e67",
-  "nodeURL": "https://rpc-mumbai.maticvigil.com/",
+  "nodeURL": "https://polygon-mumbai.blockpi.network/v1/rpc/public",
   "proxyABILocation": "../abi/IPerpetualManager.json",
   "limitOrderBookFactoryAddr": "0xe95422bf27C62F3b9ae19d6032aC58c1bd13C71E",
   "limitOrderBookFactoryABILocation": "../abi/LimitOrderBookFactory.json",

package/dist/accountTrade.d.ts

@@ -1,7 +1,7 @@
 import { ethers } from "ethers";
-import { NodeSDKConfig, Order, PerpetualStaticInfo, OrderResponse } from "./nodeSDKTypes";
-import WriteAccessHandler from "./writeAccessHandler";
+import { NodeSDKConfig, Order, OrderResponse, PerpetualStaticInfo } from "./nodeSDKTypes";
 import TraderDigests from "./traderDigests";
+import WriteAccessHandler from "./writeAccessHandler";
 /**
  * Functions to create, submit and cancel orders on the exchange.
  * This class requires a private key and executes smart-contract interactions that
@@ -206,4 +206,16 @@ export default class AccountTrade extends WriteAccessHandler {
      * @ignore
      */
     private _createSignature;
+    /**
+     *
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} amount How much collateral to add, in units of collateral currency, e.g. MATIC
+     */
+    addCollateral(symbol: string, amount: number): Promise<ethers.ContractTransaction>;
+    /**
+     *
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} amount How much collateral to remove, in units of collateral currency, e.g. MATIC
+     */
+    removeCollateral(symbol: string, amount: number): Promise<ethers.ContractTransaction>;
 }

package/dist/accountTrade.js

@@ -16,8 +16,8 @@ const d8XMath_1 = require("./d8XMath");
 const marketData_1 = __importDefault(require("./marketData"));
 const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
-const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
 const traderDigests_1 = __importDefault(require("./traderDigests"));
+const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
 /**
  * Functions to create, submit and cancel orders on the exchange.
  * This class requires a private key and executes smart-contract interactions that
@@ -308,5 +308,35 @@ class AccountTrade extends writeAccessHandler_1.default {
             return [signature, digest];
         });
     }
+    /**
+     *
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} amount How much collateral to add, in units of collateral currency, e.g. MATIC
+     */
+    addCollateral(symbol, amount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null || this.signer == null) {
+                throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+            }
+            let perpId = this.getPerpIdFromSymbol(symbol);
+            let fAmountCC = (0, d8XMath_1.floatToABK64x64)(amount);
+            return yield this.proxyContract.deposit(perpId, fAmountCC);
+        });
+    }
+    /**
+     *
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} amount How much collateral to remove, in units of collateral currency, e.g. MATIC
+     */
+    removeCollateral(symbol, amount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null || this.signer == null) {
+                throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+            }
+            let perpId = this.getPerpIdFromSymbol(symbol);
+            let fAmountCC = (0, d8XMath_1.floatToABK64x64)(amount);
+            return yield this.proxyContract.withdraw(perpId, fAmountCC);
+        });
+    }
 }
 exports.default = AccountTrade;

package/dist/index.js

@@ -38,18 +38,6 @@ const traderInterface_1 = __importDefault(require("./traderInterface"));
 exports.TraderInterface = traderInterface_1.default;
 const perpetualEventHandler_1 = __importDefault(require("./perpetualEventHandler"));
 exports.PerpetualEventHandler = perpetualEventHandler_1.default;
-// import {
-//   NodeSDKConfig,
-//   MarginAccount,
-//   CollaterlCCY,
-//   PoolStaticInfo,
-//   PerpetualStaticInfo,
-//   ExchangeInfo,
-//   PoolState,
-//   PerpetualState,
-//   Order,
-//   SmartContractOrder,
-// } from "./nodeSDKTypes";
 __exportStar(require("./nodeSDKTypes"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./d8XMath"), exports);

package/dist/marketData.d.ts

@@ -1,8 +1,7 @@
-import { ExchangeInfo, NodeSDKConfig, MarginAccount, PerpetualState, PoolStaticInfo, PerpetualStaticInfo } from "./nodeSDKTypes";
 import { ethers } from "ethers";
-import PerpetualDataHandler from "./perpetualDataHandler";
-import { SmartContractOrder, Order } from "./nodeSDKTypes";
 import "./nodeSDKTypes";
+import { ExchangeInfo, MarginAccount, NodeSDKConfig, Order, PerpetualState, PerpetualStaticInfo, PoolStaticInfo, SmartContractOrder } from "./nodeSDKTypes";
+import PerpetualDataHandler from "./perpetualDataHandler";
 /**
  * Functions to access market data (e.g., information on open orders, information on products that can be traded).
  * This class requires no private key and is blockchain read-only.
@@ -36,6 +35,11 @@ export default class MarketData extends PerpetualDataHandler {
      * @param provider optional provider
      */
     createProxyInstance(provider?: ethers.providers.JsonRpcProvider): Promise<void>;
+    /**
+   * Get the proxy address
+   * @returns Address of the perpetual proxy contract
+   */
+    getProxyAddress(): string;
     /**
      * Convert the smart contract output of an order into a convenient format of type "Order"
      * @param smOrder SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event

package/dist/marketData.js

@@ -12,12 +12,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const ethers_1 = require("ethers");
 const d8XMath_1 = require("./d8XMath");
-const utils_1 = require("./utils");
-const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
 require("./nodeSDKTypes");
+const nodeSDKTypes_1 = require("./nodeSDKTypes");
+const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
+const utils_1 = require("./utils");
 /**
  * Functions to access market data (e.g., information on open orders, information on products that can be traded).
  * This class requires no private key and is blockchain read-only.
@@ -63,6 +63,16 @@ class MarketData extends perpetualDataHandler_1.default {
             yield this.initContractsAndData(this.provider);
         });
     }
+    /**
+   * Get the proxy address
+   * @returns Address of the perpetual proxy contract
+   */
+    getProxyAddress() {
+        if (this.proxyContract == null) {
+            throw Error("no proxy contract initialized. Use createProxyInstance().");
+        }
+        return this.proxyContract.address;
+    }
     /**
      * Convert the smart contract output of an order into a convenient format of type "Order"
      * @param smOrder SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event

package/dist/nodeSDKTypes.d.ts

@@ -1,4 +1,4 @@
-import { BytesLike, BigNumber, BigNumberish, ContractTransaction } from "ethers";
+import { BigNumber, BigNumberish, BytesLike, ContractTransaction } from "ethers";
 export declare const DEFAULT_CONFIG_TESTNET = "../config/defaultConfig.json";
 export declare const DEFAULT_CONFIG_MAINNET = "notthereyet";
 export declare const DEFAULT_CONFIG_TESTNET_NAME = "testnet";

package/dist/orderReferrerTool.d.ts

@@ -1,6 +1,6 @@
-import WriteAccessHandler from "./writeAccessHandler";
-import { NodeSDKConfig, Order, PerpetualStaticInfo } from "./nodeSDKTypes";
 import { ethers } from "ethers";
+import { NodeSDKConfig, Order, PerpetualStaticInfo } from "./nodeSDKTypes";
+import WriteAccessHandler from "./writeAccessHandler";
 /**
  * Functions to execute existing conditional orders from the limit order book. This class
  * requires a private key and executes smart-contract interactions that require

package/dist/orderReferrerTool.js

@@ -12,10 +12,10 @@ 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"));
-const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const ethers_1 = require("ethers");
+const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
+const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
 /**
  * Functions to execute existing conditional orders from the limit order book. This class
  * requires a private key and executes smart-contract interactions that require

package/dist/perpetualEventHandler.d.ts

@@ -1,6 +1,6 @@
 import { BigNumber } from "ethers";
-import { PerpetualState, ExchangeInfo, SmartContractOrder, MarginAccount, OrderStruct, TradeEvent } from "./nodeSDKTypes";
 import MarketData from "./marketData";
+import { ExchangeInfo, MarginAccount, OrderStruct, PerpetualState, SmartContractOrder, TradeEvent } from "./nodeSDKTypes";
 /**
  * This class handles events and stores relevant variables
  * as member variables. The events change the state of the member variables:

package/dist/perpetualEventHandler.js

@@ -9,9 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const process_1 = require("process");
 const d8XMath_1 = require("./d8XMath");
 const nodeSDKTypes_1 = require("./nodeSDKTypes");
-const process_1 = require("process");
 /**
  * This class handles events and stores relevant variables
  * as member variables. The events change the state of the member variables:

package/dist/writeAccessHandler.d.ts

@@ -1,6 +1,6 @@
 import { BigNumber, ethers } from "ethers";
-import PerpetualDataHandler from "./perpetualDataHandler";
 import { NodeSDKConfig } from "./nodeSDKTypes";
+import PerpetualDataHandler from "./perpetualDataHandler";
 /**
  * This is a parent class for the classes that require
  * write access to the contracts.

package/dist/writeAccessHandler.js

@@ -13,9 +13,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
-const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
-const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const d8XMath_1 = require("./d8XMath");
+const nodeSDKTypes_1 = require("./nodeSDKTypes");
+const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
 /**
  * This is a parent class for the classes that require
  * write access to the contracts.

package/package.json

@@ -1,33 +1,38 @@
 {
   "dependencies": {
-    "@babel/core": "^7.20.2",
-    "@types/jest": "^29.2.3",
-    "@types/node": "^18.11.9",
-    "babel-jest": "^29.3.1",
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/strings": "^5.7.0",
     "ethers": "^5.7.2",
-    "jest": "^29.3.1",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "process": "^0.11.10"
   },
   "scripts": {
     "build": "tsc",
     "build:doc": "jsdoc2md --files ./src/accountTrade.ts --configure ./jsdoc2md.json > ./doc/accountTrade.md && jsdoc2md --files ./src/marketData.ts --configure ./jsdoc2md.json > ./doc/marketData.md && jsdoc2md --files ./src/liquidatorTool.ts --configure ./jsdoc2md.json > ./doc/liquidatorTool.md && jsdoc2md --files ./src/liquidityProviderTool.ts --configure ./jsdoc2md.json > ./doc/liquidityProviderTool.md && jsdoc2md --files ./src/brokerTool.ts --configure ./jsdoc2md.json > ./doc/brokerTool.md && jsdoc2md --files ./src/orderReferrerTool.ts --configure ./jsdoc2md.json > ./doc/orderReferrerTool.md && jsdoc2md --files ./src/*.ts --configure ./jsdoc2md.json > ./doc/d8x-perpetuals-sdk.md",
     "test": "jest",
-    "coverage": "nyc -r lcov -e .ts -x \"*.test.ts\" npm run test"
+    "coverage": "nyc -r lcov -e .ts -x \"*.test.ts\" npm run test",
+    "prepubish": "test test/readonly.test && build:doc"
   },
   "devDependencies": {
+    "@babel/core": "^7.20.2",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-object-rest-spread": "^7.20.2",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^29.2.3",
+    "@types/node": "^18.11.9",
+    "babel-jest": "^29.3.1",
+    "jest": "^29.3.1",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-to-markdown": "^7.1.1",
-    "json2md": "^2.0.0"
+    "json2md": "^2.0.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
   },
   "name": "@d8x/perpetuals-sdk",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "directories": {
@@ -54,8 +59,8 @@
     "sdk",
     "api"
   ],
-  "author": "d8x",
-  "license": "UNLICENSED",
+  "author": "D8X",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/D8-X/d8x-futures-node-sdk/issues"
   },

package/src/accountTrade.ts

@@ -1,19 +1,17 @@
 import { ethers } from "ethers";
-
-import { ABK64x64ToFloat } from "./d8XMath";
+import { ABK64x64ToFloat, floatToABK64x64 } from "./d8XMath";
 import MarketData from "./marketData";
 import {
   NodeSDKConfig,
   Order,
+  OrderResponse,
+  PerpetualStaticInfo,
   SmartContractOrder,
   ZERO_ADDRESS,
-  ORDER_TYPE_MARKET,
-  PerpetualStaticInfo,
-  OrderResponse,
 } from "./nodeSDKTypes";
 import PerpetualDataHandler from "./perpetualDataHandler";
-import WriteAccessHandler from "./writeAccessHandler";
 import TraderDigests from "./traderDigests";
+import WriteAccessHandler from "./writeAccessHandler";
 
 /**
  * Functions to create, submit and cancel orders on the exchange.
@@ -329,4 +327,32 @@ export default class AccountTrade extends WriteAccessHandler {
     let signature = await signer.signMessage(digestBuffer);
     return [signature, digest];
   }
+
+  /**
+   *
+   * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+   * @param {number} amount How much collateral to add, in units of collateral currency, e.g. MATIC
+   */
+  public async addCollateral(symbol: string, amount: number): Promise<ethers.ContractTransaction> {
+    if (this.proxyContract == null || this.signer == null) {
+      throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+    }
+    let perpId = this.getPerpIdFromSymbol(symbol);
+    let fAmountCC = floatToABK64x64(amount);
+    return await this.proxyContract.deposit(perpId, fAmountCC);
+  }
+
+  /**
+   *
+   * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+   * @param {number} amount How much collateral to remove, in units of collateral currency, e.g. MATIC
+   */
+  public async removeCollateral(symbol: string, amount: number): Promise<ethers.ContractTransaction> {
+    if (this.proxyContract == null || this.signer == null) {
+      throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+    }
+    let perpId = this.getPerpIdFromSymbol(symbol);
+    let fAmountCC = floatToABK64x64(amount);
+    return await this.proxyContract.withdraw(perpId, fAmountCC);
+  }
 }

package/src/d8XMath.ts

@@ -1,4 +1,3 @@
-import { assert } from "console";
 import { BigNumber } from "ethers";
 import { DECIMALS, ONE_64x64 } from "./nodeSDKTypes";
 

package/src/index.ts

@@ -8,18 +8,7 @@ import WriteAccessHandler from "./writeAccessHandler";
 import LiquidatorTool from "./liquidatorTool";
 import TraderInterface from "./traderInterface";
 import PerpetualEventHandler from "./perpetualEventHandler";
-// import {
-//   NodeSDKConfig,
-//   MarginAccount,
-//   CollaterlCCY,
-//   PoolStaticInfo,
-//   PerpetualStaticInfo,
-//   ExchangeInfo,
-//   PoolState,
-//   PerpetualState,
-//   Order,
-//   SmartContractOrder,
-// } from "./nodeSDKTypes";
+
 export * from "./nodeSDKTypes";
 export * from "./utils";
 export * from "./d8XMath";

package/src/marketData.ts

@@ -1,35 +1,35 @@
+import { BigNumber, ethers } from "ethers";
 import {
+  ABK64x64ToFloat,
+  calculateLiquidationPriceCollateralBase,
+  calculateLiquidationPriceCollateralQuanto,
+  calculateLiquidationPriceCollateralQuote,
+  getMarginRequiredForLeveragedTrade,
+  getMaxSignedPositionSize,
+  getNewPositionLeverage,
+} from "./d8XMath";
+import "./nodeSDKTypes";
+import {
+  BUY_SIDE,
+  CLOSED_SIDE,
+  COLLATERAL_CURRENCY_BASE,
+  COLLATERAL_CURRENCY_QUANTO,
+  CollaterlCCY,
   ExchangeInfo,
-  NodeSDKConfig,
   MarginAccount,
-  PoolState,
+  NodeSDKConfig,
+  Order,
   PerpetualState,
-  COLLATERAL_CURRENCY_BASE,
-  COLLATERAL_CURRENCY_QUANTO,
+  PerpetualStaticInfo,
   PERP_STATE_STR,
-  ZERO_ADDRESS,
+  PoolState,
   PoolStaticInfo,
-  BUY_SIDE,
-  CLOSED_SIDE,
   SELL_SIDE,
-  CollaterlCCY,
-  PerpetualStaticInfo,
+  SmartContractOrder,
+  ZERO_ADDRESS,
 } from "./nodeSDKTypes";
-import { BigNumber, BytesLike, ethers } from "ethers";
-import {
-  floatToABK64x64,
-  ABK64x64ToFloat,
-  getNewPositionLeverage,
-  getMarginRequiredForLeveragedTrade,
-  calculateLiquidationPriceCollateralBase,
-  calculateLiquidationPriceCollateralQuanto,
-  calculateLiquidationPriceCollateralQuote,
-  getMaxSignedPositionSize,
-} from "./d8XMath";
-import { contractSymbolToSymbol, fromBytes4HexString, toBytes4 } from "./utils";
 import PerpetualDataHandler from "./perpetualDataHandler";
-import { SmartContractOrder, Order } from "./nodeSDKTypes";
-import "./nodeSDKTypes";
+import { contractSymbolToSymbol, toBytes4 } from "./utils";
 
 /**
  * Functions to access market data (e.g., information on open orders, information on products that can be traded).
@@ -75,6 +75,17 @@ export default class MarketData extends PerpetualDataHandler {
     await this.initContractsAndData(this.provider);
   }
 
+    /**
+   * Get the proxy address
+   * @returns Address of the perpetual proxy contract
+   */
+    public getProxyAddress(): string {
+      if (this.proxyContract == null) {
+        throw Error("no proxy contract initialized. Use createProxyInstance().");
+      }
+      return this.proxyContract.address;
+    }
+
   /**
    * Convert the smart contract output of an order into a convenient format of type "Order"
    * @param smOrder SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event

package/src/nodeSDKTypes.ts

@@ -1,4 +1,4 @@
-import { BytesLike, BigNumber, BigNumberish, constants, ContractTransaction } from "ethers";
+import { BigNumber, BigNumberish, BytesLike, constants, ContractTransaction } from "ethers";
 export const DEFAULT_CONFIG_TESTNET = "../config/defaultConfig.json";
 export const DEFAULT_CONFIG_MAINNET = "notthereyet";
 export const DEFAULT_CONFIG_TESTNET_NAME = "testnet";

package/src/orderReferrerTool.ts

@@ -1,4 +1,4 @@
-import WriteAccessHandler from "./writeAccessHandler";
+import { BigNumber, ethers } from "ethers";
 import {
   BUY_SIDE,
   NodeSDKConfig,
@@ -8,8 +8,8 @@ import {
   ZERO_ADDRESS,
   ZERO_ORDER_ID,
 } from "./nodeSDKTypes";
-import { BigNumber, ethers } from "ethers";
 import PerpetualDataHandler from "./perpetualDataHandler";
+import WriteAccessHandler from "./writeAccessHandler";
 
 /**
  * Functions to execute existing conditional orders from the limit order book. This class

package/src/perpetualEventHandler.ts

@@ -1,17 +1,17 @@
-import { BigNumber, utils } from "ethers";
-import { ABK64x64ToFloat, mul64x64, div64x64 } from "./d8XMath";
+import { BigNumber } from "ethers";
+import { emitWarning } from "process";
+import { ABK64x64ToFloat, mul64x64 } from "./d8XMath";
+import MarketData from "./marketData";
 import {
-  PerpetualState,
-  ONE_64x64,
   ExchangeInfo,
-  Order,
-  SmartContractOrder,
   MarginAccount,
+  ONE_64x64,
+  Order,
   OrderStruct,
+  PerpetualState,
+  SmartContractOrder,
   TradeEvent,
 } from "./nodeSDKTypes";
-import { emitWarning } from "process";
-import MarketData from "./marketData";
 
 /**
  * This class handles events and stores relevant variables

package/src/writeAccessHandler.ts

@@ -1,8 +1,7 @@
-import { BigNumber, BigNumberish, ethers, Wallet } from "ethers";
-import PerpetualDataHandler from "./perpetualDataHandler";
-import { NodeSDKConfig, MAX_UINT_256, ERC20_ABI } from "./nodeSDKTypes";
-import { to4Chars } from "./utils";
+import { BigNumber, ethers } from "ethers";
 import { floatToDec18 } from "./d8XMath";
+import { ERC20_ABI, MAX_UINT_256, NodeSDKConfig } from "./nodeSDKTypes";
+import PerpetualDataHandler from "./perpetualDataHandler";
 
 /**
  * This is a parent class for the classes that require