@d8x/perpetuals-sdk 0.0.8 → 0.0.9

package/dist/liquidityProviderTool.d.ts

@@ -2,20 +2,51 @@ import { ethers } from "ethers";
 import WriteAccessHandler from "./writeAccessHandler";
 import { NodeSDKConfig } from "./nodeSDKTypes";
 /**
- * Methods to provide liquidity
+ * Functions to provide liquidity. This class requires a private key and executes
+ * smart-contract interactions that require gas-payments.
  */
 export default class LiquidityProviderTool extends WriteAccessHandler {
     /**
      * Constructor
-     * @param config configuration
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // LiquidityProviderTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await lqudtProviderTool.createProxyInstance();
+     * }
+     * main();
+     *
      * @param privateKey private key of account that trades
      */
     constructor(config: NodeSDKConfig, privateKey: string);
     /**
-     * Value of the share tokens for this liquidity provider
+     * Value of the pool share tokens for this liquidity provider
      * in poolSymbol-currency (e.g. MATIC, USDC).
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
-     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balabce of share tokens, and share token symbol.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // get value of pool share token
+     *   let shareToken = await lqudtProviderTool.getParticipationValue("MATIC");
+     *   console.log(shareToken);
+     * }
+     * main();
+     *
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balance of pool share tokens, and share token symbol.
      */
     getParticipationValue(poolSymbolName: string): Promise<{
         value: number;
@@ -24,15 +55,45 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
     }>;
     /**
      *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
-     * @param {string} poolname  Name of pool symbol (e.g. MATIC)
+     * @param {string} poolSymbolName  Name of pool symbol (e.g. MATIC)
      * @param {number} amountCC  Amount in pool-collateral currency
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // add liquidity
+     *   let respAddLiquidity = await lqudtProviderTool.addLiquidity("MATIC", 0.1);
+     *   console.log(respAddLiquidity);
+     * }
+     * main();
+     *
      * @return Transaction object
      */
     addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.ContractTransaction>;
     /**
-     * Remove liquidity from the pool.
+     * Remove liquidity from the pool. The address loses pool shares in return.
      * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
-     * @param {string} amountPoolShares Amount in pool-tokens, removes everything if > available amount.
+     * @param {string} amountPoolShares Amount in pool-shares, removes everything if > available amount.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // remove liquidity
+     *   let respRemoveLiquidity = await lqudtProviderTool.removeLiquidity("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
      * @return Transaction object.
      */
     removeLiquidity(poolSymbolName: string, amountPoolShares: number): Promise<ethers.providers.TransactionResponse>;

package/dist/liquidityProviderTool.js

@@ -18,22 +18,53 @@ const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
 const d8XMath_1 = require("./d8XMath");
 /**
- * Methods to provide liquidity
+ * Functions to provide liquidity. This class requires a private key and executes
+ * smart-contract interactions that require gas-payments.
  */
 class LiquidityProviderTool extends writeAccessHandler_1.default {
     /**
      * Constructor
-     * @param config configuration
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // LiquidityProviderTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await lqudtProviderTool.createProxyInstance();
+     * }
+     * main();
+     *
      * @param privateKey private key of account that trades
      */
     constructor(config, privateKey) {
         super(config, privateKey);
     }
     /**
-     * Value of the share tokens for this liquidity provider
+     * Value of the pool share tokens for this liquidity provider
      * in poolSymbol-currency (e.g. MATIC, USDC).
      * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
-     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balabce of share tokens, and share token symbol.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // get value of pool share token
+     *   let shareToken = await lqudtProviderTool.getParticipationValue("MATIC");
+     *   console.log(shareToken);
+     * }
+     * main();
+     *
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balance of pool share tokens, and share token symbol.
      */
     getParticipationValue(poolSymbolName) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -62,8 +93,23 @@ class LiquidityProviderTool extends writeAccessHandler_1.default {
     }
     /**
      *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
-     * @param {string} poolname  Name of pool symbol (e.g. MATIC)
+     * @param {string} poolSymbolName  Name of pool symbol (e.g. MATIC)
      * @param {number} amountCC  Amount in pool-collateral currency
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // add liquidity
+     *   let respAddLiquidity = await lqudtProviderTool.addLiquidity("MATIC", 0.1);
+     *   console.log(respAddLiquidity);
+     * }
+     * main();
+     *
      * @return Transaction object
      */
     addLiquidity(poolSymbolName, amountCC) {
@@ -79,9 +125,24 @@ class LiquidityProviderTool extends writeAccessHandler_1.default {
         });
     }
     /**
-     * Remove liquidity from the pool.
+     * Remove liquidity from the pool. The address loses pool shares in return.
      * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
-     * @param {string} amountPoolShares Amount in pool-tokens, removes everything if > available amount.
+     * @param {string} amountPoolShares Amount in pool-shares, removes everything if > available amount.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // 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 lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // remove liquidity
+     *   let respRemoveLiquidity = await lqudtProviderTool.removeLiquidity("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
      * @return Transaction object.
      */
     removeLiquidity(poolSymbolName, amountPoolShares) {

package/dist/marketData.d.ts

@@ -3,19 +3,66 @@ import { ethers } from "ethers";
 import PerpetualDataHandler from "./perpetualDataHandler";
 import { Order } from "./nodeSDKTypes";
 /**
+ * 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.
  * No gas required for the queries here.
  */
 export default class MarketData extends PerpetualDataHandler {
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // MarketData (read only, no authentication needed)
+     *   let mktData = new MarketData(config);
+     *   // Create a proxy instance to access the blockchain
+     *   await mktData.createProxyInstance();
+     * }
+     * main();
+     *
+     */
     constructor(config: NodeSDKConfig);
     createProxyInstance(): Promise<void>;
     /**
      * Get contract instance. Useful for event listening.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get contract instance
+     *   let proxy = await mktData.getReadOnlyProxyInstance();
+     *   console.log(proxy);
+     * }
+     * main();
+     *
      * @returns read-only proxy instance
      */
     getReadOnlyProxyInstance(): ethers.Contract;
     /**
      * Information about the products traded in the exchange.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get exchange info
+     *   let info = await mktData.exchangeInfo();
+     *   console.log(info);
+     * }
+     * main();
+     *
      * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
      */
     exchangeInfo(): Promise<ExchangeInfo>;
@@ -23,6 +70,29 @@ export default class MarketData extends PerpetualDataHandler {
      * All open orders for a trader-address and a symbol.
      * @param {string} traderAddr Address of the trader for which we get the open orders.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * // Setup
+     * const config = PerpetualDataHandler.readSDKConfig("testnet");
+     * let mktData = new MarketData(config);
+     * await mktData.createProxyInstance();
+     * // Get all open orders for a trader/symbol
+     * let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *     "ETH-USD-MATIC");
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get all open orders for a trader/symbol
+     *   let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *       "ETH-USD-MATIC");
+     *   console.log(opOrder);
+     * }
+     * main();
+     *
      * @returns {Array<Array<Order>, Array<string>>} Array of open orders and corresponding order-ids.
      */
     openOrders(traderAddr: string, symbol: string): Promise<{
@@ -30,9 +100,32 @@ export default class MarketData extends PerpetualDataHandler {
         orderIds: string[];
     }>;
     /**
-     * Information about the position open by a given trader in a given perpetual contract.
+     * Information about the positions open by a given trader in a given perpetual contract.
      * @param {string} traderAddr Address of the trader for which we get the position risk.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * // Setup
+     * const config = PerpetualDataHandler.readSDKConfig("testnet");
+     * let mktData = new MarketData(config);
+     * await mktData.createProxyInstance();
+     * // Get position risk info
+     * let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *     "ETH-USD-MATIC");
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get position risk info
+     *   let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *       "ETH-USD-MATIC");
+     *   console.log(posRisk);
+     * }
+     * main();
+     *
      * @returns {MarginAccount}
      */
     positionRisk(traderAddr: string, symbol: string): Promise<MarginAccount>;
@@ -40,12 +133,40 @@ export default class MarketData extends PerpetualDataHandler {
      * 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.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get oracle price
+     *   let price = await mktData.getOraclePrice("ETH", "USD");
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @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
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get mark price
+     *   let price = await mktData.getMarkPrice("ETH-USD-MATIC");
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @returns mark price
      */
     getMarkPrice(symbol: string): Promise<number>;
@@ -53,6 +174,20 @@ export default class MarketData extends PerpetualDataHandler {
      * 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
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get perpetual price
+     *   let price = await mktData.getPerpetualPrice("ETH-USD-MATIC", 1);
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @returns price (number)
      */
     getPerpetualPrice(symbol: string, quantity: number): Promise<number>;
@@ -66,11 +201,11 @@ export default class MarketData extends PerpetualDataHandler {
     protected openOrdersOnOrderBook(traderAddr: string, orderBookContract: ethers.Contract): Promise<Order[]>;
     /**
      *
-     * @param traderAddr address of the trader
-     * @param orderBookContract instance of order book contract
-     * @returns array of order-id's
+     * @param traderAddr Address of the trader
+     * @param orderBookContract Instance of order book contract
+     * @returns Array of order-id's
      * @ignore
      */
-    protected orderIdsOfTrader(traderAddr: string, orderBookContract: ethers.Contract): Promise<string[]>;
+    static orderIdsOfTrader(traderAddr: string, orderBookContract: ethers.Contract): Promise<string[]>;
     static _exchangeInfo(_proxyContract: ethers.Contract): Promise<ExchangeInfo>;
 }

package/dist/marketData.js

@@ -18,10 +18,29 @@ const d8XMath_1 = require("./d8XMath");
 const utils_1 = require("./utils");
 const perpetualDataHandler_1 = __importDefault(require("./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.
  * No gas required for the queries here.
  */
 class MarketData extends perpetualDataHandler_1.default {
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see
+     * PerpetualDataHandler.readSDKConfig.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // MarketData (read only, no authentication needed)
+     *   let mktData = new MarketData(config);
+     *   // Create a proxy instance to access the blockchain
+     *   await mktData.createProxyInstance();
+     * }
+     * main();
+     *
+     */
     constructor(config) {
         super(config);
     }
@@ -33,6 +52,20 @@ class MarketData extends perpetualDataHandler_1.default {
     }
     /**
      * Get contract instance. Useful for event listening.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get contract instance
+     *   let proxy = await mktData.getReadOnlyProxyInstance();
+     *   console.log(proxy);
+     * }
+     * main();
+     *
      * @returns read-only proxy instance
      */
     getReadOnlyProxyInstance() {
@@ -43,6 +76,20 @@ class MarketData extends perpetualDataHandler_1.default {
     }
     /**
      * Information about the products traded in the exchange.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get exchange info
+     *   let info = await mktData.exchangeInfo();
+     *   console.log(info);
+     * }
+     * main();
+     *
      * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
      */
     exchangeInfo() {
@@ -57,6 +104,29 @@ class MarketData extends perpetualDataHandler_1.default {
      * All open orders for a trader-address and a symbol.
      * @param {string} traderAddr Address of the trader for which we get the open orders.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * // Setup
+     * const config = PerpetualDataHandler.readSDKConfig("testnet");
+     * let mktData = new MarketData(config);
+     * await mktData.createProxyInstance();
+     * // Get all open orders for a trader/symbol
+     * let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *     "ETH-USD-MATIC");
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get all open orders for a trader/symbol
+     *   let opOrder = await mktData.openOrders("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *       "ETH-USD-MATIC");
+     *   console.log(opOrder);
+     * }
+     * main();
+     *
      * @returns {Array<Array<Order>, Array<string>>} Array of open orders and corresponding order-ids.
      */
     openOrders(traderAddr, symbol) {
@@ -65,15 +135,38 @@ class MarketData extends perpetualDataHandler_1.default {
             let orderBookContract = this.getOrderBookContract(symbol);
             let [orders, digests] = yield Promise.all([
                 this.openOrdersOnOrderBook(traderAddr, orderBookContract),
-                this.orderIdsOfTrader(traderAddr, orderBookContract),
+                MarketData.orderIdsOfTrader(traderAddr, orderBookContract),
             ]);
             return { orders: orders, orderIds: digests };
         });
     }
     /**
-     * Information about the position open by a given trader in a given perpetual contract.
+     * Information about the positions open by a given trader in a given perpetual contract.
      * @param {string} traderAddr Address of the trader for which we get the position risk.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * // Setup
+     * const config = PerpetualDataHandler.readSDKConfig("testnet");
+     * let mktData = new MarketData(config);
+     * await mktData.createProxyInstance();
+     * // Get position risk info
+     * let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *     "ETH-USD-MATIC");
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // Get position risk info
+     *   let posRisk = await mktData.positionRisk("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
+     *       "ETH-USD-MATIC");
+     *   console.log(posRisk);
+     * }
+     * main();
+     *
      * @returns {MarginAccount}
      */
     positionRisk(traderAddr, symbol) {
@@ -89,6 +182,20 @@ class MarketData extends perpetualDataHandler_1.default {
      * 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.
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get oracle price
+     *   let price = await mktData.getOraclePrice("ETH", "USD");
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @returns {number} Price of index in given currency.
      */
     getOraclePrice(base, quote) {
@@ -103,6 +210,20 @@ class MarketData extends perpetualDataHandler_1.default {
     /**
      * Get the current mark price
      * @param symbol symbol of the form ETH-USD-MATIC
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get mark price
+     *   let price = await mktData.getMarkPrice("ETH-USD-MATIC");
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @returns mark price
      */
     getMarkPrice(symbol) {
@@ -117,6 +238,20 @@ class MarketData extends perpetualDataHandler_1.default {
      * 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
+     * @example
+     * import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(MarketData);
+     *   // setup
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   let mktData = new MarketData(config);
+     *   await mktData.createProxyInstance();
+     *   // get perpetual price
+     *   let price = await mktData.getPerpetualPrice("ETH-USD-MATIC", 1);
+     *   console.log(price);
+     * }
+     * main();
+     *
      * @returns price (number)
      */
     getPerpetualPrice(symbol, quantity) {
@@ -149,12 +284,12 @@ class MarketData extends perpetualDataHandler_1.default {
     }
     /**
      *
-     * @param traderAddr address of the trader
-     * @param orderBookContract instance of order book contract
-     * @returns array of order-id's
+     * @param traderAddr Address of the trader
+     * @param orderBookContract Instance of order book contract
+     * @returns Array of order-id's
      * @ignore
      */
-    orderIdsOfTrader(traderAddr, orderBookContract) {
+    static orderIdsOfTrader(traderAddr, orderBookContract) {
         return __awaiter(this, void 0, void 0, function* () {
             let digestsRaw = yield orderBookContract.limitDigestsOfTrader(traderAddr, 0, 15);
             let k = 0;

package/dist/nodeSDKTypes.d.ts

@@ -8,6 +8,11 @@ export declare const COLLATERAL_CURRENCY_QUOTE = 0;
 export declare const COLLATERAL_CURRENCY_BASE = 1;
 export declare const COLLATERAL_CURRENCY_QUANTO = 2;
 export declare const PERP_STATE_STR: string[];
+export declare const PerpetualStateINVALID = 0;
+export declare const PerpetualStateINITIALIZING = 1;
+export declare const PerpetualStateNORMAL = 2;
+export declare const PerpetualStateEMERGENCY = 3;
+export declare const PerpetualStateCLEARED = 4;
 export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
 export declare const ZERO_ORDER_ID = "0x0000000000000000000000000000000000000000000000000000000000000000";
 export declare const ONE_64x64: 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_ORDER_ID = exports.ZERO_ADDRESS = exports.PerpetualStateCLEARED = exports.PerpetualStateEMERGENCY = exports.PerpetualStateNORMAL = exports.PerpetualStateINITIALIZING = exports.PerpetualStateINVALID = 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,6 +11,11 @@ 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.PerpetualStateINVALID = 0;
+exports.PerpetualStateINITIALIZING = 1;
+exports.PerpetualStateNORMAL = 2;
+exports.PerpetualStateEMERGENCY = 3;
+exports.PerpetualStateCLEARED = 4;
 exports.ZERO_ADDRESS = ethers_1.constants.AddressZero;
 exports.ZERO_ORDER_ID = ethers_1.constants.HashZero;
 exports.ONE_64x64 = ethers_1.BigNumber.from("0x010000000000000000");