@d8x/perpetuals-sdk 1.3.7 → 2.0.0-alpha

package/dist/cjs/liquidityProviderTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"liquidityProviderTool.js","sourceRoot":"","sources":["../../src/liquidityProviderTool.ts"],"names":[],"mappings":";;;;;AAEA,uCAAsD;AAEtD,kFAA0D;AAC1D,8EAAsD;AACtD;;;;GAIG;AACH,MAAqB,qBAAsB,SAAQ,4BAAkB;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,YAAY,CACvB,cAAsB,EACtB,QAAgB,EAChB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,QAAQ,GAAG,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,CAAC;QACrE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAC5C,MAAM,EACN,IAAA,qBAAW,EAAC,QAAQ,EAAE,QAAS,CAAC,EAChC,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,2BAA2B,CACtC,cAAsB,EACtB,gBAAwB,EACxB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CACjD,MAAM,EACN,IAAA,sBAAY,EAAC,gBAAgB,CAAC,EAC9B,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,0BAA0B,CAAC,cAAsB,EAAE,SAAqB;QACnF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAC1D,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AA1ID,wCA0IC"}
+{"version":3,"file":"liquidityProviderTool.js","sourceRoot":"","sources":["../../src/liquidityProviderTool.ts"],"names":[],"mappings":";;;;;AACA,uCAAsD;AAEtD,kFAA0D;AAC1D,8EAAsD;AACtD;;;;GAIG;AACH,MAAqB,qBAAsB,SAAQ,4BAAkB;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,YAAY,CACvB,cAAsB,EACtB,QAAgB,EAChB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,QAAQ,GAAG,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,CAAC;QACrE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAC5C,MAAM,EACN,IAAA,qBAAW,EAAC,QAAQ,EAAE,QAAS,CAAC,EAChC,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,2BAA2B,CACtC,cAAsB,EACtB,gBAAwB,EACxB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CACjD,MAAM,EACN,IAAA,sBAAY,EAAC,gBAAgB,CAAC,EAC9B,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,0BAA0B,CACrC,cAAsB,EACtB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAC1D,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AA7ID,wCA6IC"}

package/dist/cjs/marketData.d.ts

@@ -1,5 +1,4 @@
-import { CallOverrides, Contract } from "@ethersproject/contracts";
-import { Provider } from "@ethersproject/providers";
+import { Contract, Overrides, Provider } from "ethers";
 import { OrderStatus } from "./constants";
 import { type LimitOrderBook, type Multicall3 } from "./contracts";
 import { IPerpetualOrder, type PerpStorage } from "./contracts/IPerpetualManager";
@@ -39,7 +38,7 @@ export default class MarketData extends PerpetualDataHandler {
      * about perpetual currencies
      * @param provider optional provider to perform blockchain calls
      */
-    createProxyInstance(provider?: Provider, overrides?: CallOverrides): Promise<void>;
+    createProxyInstance(provider?: Provider, overrides?: Overrides): Promise<void>;
     /**
      * Initialize the marketData-Class with this function
      * to create instance of D8X perpetual contract and gather information
@@ -100,7 +99,7 @@ export default class MarketData extends PerpetualDataHandler {
      *
      * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
      */
-    exchangeInfo(overrides?: CallOverrides & {
+    exchangeInfo(overrides?: Overrides & {
         rpcURL?: string;
     }): Promise<ExchangeInfo>;
     /**
@@ -126,7 +125,7 @@ export default class MarketData extends PerpetualDataHandler {
      *
      * @returns For each perpetual an array of open orders and corresponding order-ids.
      */
-    openOrders(traderAddr: string, symbol?: string, overrides?: CallOverrides & {
+    openOrders(traderAddr: string, symbol?: string, overrides?: Overrides & {
         rpcURL?: string;
     }): Promise<{
         orders: Order[];
@@ -172,7 +171,7 @@ export default class MarketData extends PerpetualDataHandler {
      *
      * @returns {Array<MarginAccount>} Array of position risks of trader.
      */
-    positionRisk(traderAddr: string, symbol?: string, overrides?: CallOverrides & {
+    positionRisk(traderAddr: string, symbol?: string, overrides?: Overrides & {
         rpcURL?: string;
     }): Promise<MarginAccount[]>;
     /**
@@ -182,7 +181,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns MarginAccount struct for the trader
      * @ignore
      */
-    protected _positionRiskForTraderInPerpetual(traderAddr: string, symbol: string, provider: Provider, overrides?: CallOverrides): Promise<MarginAccount>;
+    protected _positionRiskForTraderInPerpetual(traderAddr: string, symbol: string, provider: Provider, overrides?: Overrides): Promise<MarginAccount>;
     /**
      * Information about the position open by a given trader in a given perpetual contract.
      * @param {string} traderAddr Address of the trader for which we get the position risk.
@@ -190,7 +189,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns MarginAccount struct for the trader
      * @ignore
      */
-    protected _positionRiskForTraderInPerpetuals(traderAddr: string, symbols: string[], provider: Provider, overrides?: CallOverrides): Promise<MarginAccount[]>;
+    protected _positionRiskForTraderInPerpetuals(traderAddr: string, symbols: string[], provider: Provider, overrides?: Overrides): Promise<MarginAccount[]>;
     /**
      * Estimates what the position risk will be if a given order is executed.
      * @param traderAddr Address of trader
@@ -220,7 +219,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    positionRiskOnTrade(traderAddr: string, order: Order, account?: MarginAccount, indexPriceInfo?: [number, number, boolean, boolean], overrides?: CallOverrides & {
+    positionRiskOnTrade(traderAddr: string, order: Order, account?: MarginAccount, indexPriceInfo?: [number, number, boolean, boolean], overrides?: Overrides & {
         tradingFeeTbps?: number;
     }): Promise<{
         newPositionRisk: MarginAccount;
@@ -249,7 +248,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    positionRiskOnCollateralAction(deltaCollateral: number, account: MarginAccount, indexPriceInfo?: [number, number, boolean, boolean], overrides?: CallOverrides): Promise<MarginAccount>;
+    positionRiskOnCollateralAction(deltaCollateral: number, account: MarginAccount, indexPriceInfo?: [number, number, boolean, boolean], overrides?: Overrides): Promise<MarginAccount>;
     /**
      * Calculates liquidation prices for a given position
      * @param symbol Perpetual symbol
@@ -283,7 +282,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getWalletBalance(address: string, symbol: string, overrides?: CallOverrides): Promise<number>;
+    getWalletBalance(address: string, symbol: string, overrides?: Overrides): Promise<number>;
     /**
      * Get the address' balance of the pool share token
      * @param {string} address address of the liquidity provider
@@ -303,7 +302,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getPoolShareTokenBalance(address: string, symbolOrId: string | number, overrides?: CallOverrides): Promise<number>;
+    getPoolShareTokenBalance(address: string, symbolOrId: string | number, overrides?: Overrides): Promise<number>;
     /**
      * Query the pool share token holdings of address
      * @param address address of token holder
@@ -330,7 +329,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getShareTokenPrice(symbolOrId: string | number, overrides?: CallOverrides): Promise<number>;
+    getShareTokenPrice(symbolOrId: string | number, overrides?: Overrides): Promise<number>;
     /**
      * Value of the pool share tokens for this liquidity provider
      * in poolSymbol-currency (e.g. MATIC, USDC).
@@ -351,7 +350,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getParticipationValue(address: string, symbolOrId: string | number, overrides?: CallOverrides): Promise<{
+    getParticipationValue(address: string, symbolOrId: string | number, overrides?: Overrides): Promise<{
         value: number;
         shareTokenBalance: number;
         poolShareToken: string;
@@ -384,7 +383,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    maxOrderSizeForTrader(traderAddr: string, symbol: string, overrides?: CallOverrides): Promise<{
+    maxOrderSizeForTrader(traderAddr: string, symbol: string, overrides?: Overrides): Promise<{
         buy: number;
         sell: number;
     }>;
@@ -407,7 +406,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    maxSignedPosition(side: string, symbol: string, overrides?: CallOverrides): Promise<number>;
+    maxSignedPosition(side: string, symbol: string, overrides?: Overrides): Promise<number>;
     /**
      * 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.
@@ -428,7 +427,7 @@ export default class MarketData extends PerpetualDataHandler {
      *
      * @returns {number} Price of index in given currency.
      */
-    getOraclePrice(base: string, quote: string, overrides?: CallOverrides): Promise<number | undefined>;
+    getOraclePrice(base: string, quote: string, overrides?: Overrides): Promise<number | undefined>;
     /**
      * Get the status of an order given a symbol and order Id
      * @param symbol Symbol of the form ETH-USD-MATIC
@@ -450,7 +449,7 @@ export default class MarketData extends PerpetualDataHandler {
      * main();
      *
      */
-    getOrderStatus(symbol: string, orderId: string, overrides?: CallOverrides): Promise<OrderStatus>;
+    getOrderStatus(symbol: string, orderId: string, overrides?: Overrides): Promise<OrderStatus>;
     /**
      * Get the status of an array of orders given a symbol and their Ids
      * @param symbol Symbol of the form ETH-USD-MATIC
@@ -471,7 +470,7 @@ export default class MarketData extends PerpetualDataHandler {
      * main();
      *
      */
-    getOrdersStatus(symbol: string, orderId: string[], overrides?: CallOverrides): Promise<OrderStatus[]>;
+    getOrdersStatus(symbol: string, orderId: string[], overrides?: Overrides): Promise<OrderStatus[]>;
     /**
      * Get the current mark price
      * @param symbol symbol of the form ETH-USD-MATIC
@@ -512,19 +511,19 @@ export default class MarketData extends PerpetualDataHandler {
      *
      * @returns {number} price
      */
-    getPerpetualPrice(symbol: string, quantity: number, indexPrices?: [number, number], overrides?: CallOverrides): Promise<number>;
+    getPerpetualPrice(symbol: string, quantity: number, indexPrices?: [number, number], overrides?: Overrides): Promise<number>;
     /**
      * Query recent perpetual state from blockchain
      * @param {string} symbol symbol of the form ETH-USD-MATIC
      * @returns {PerpetualState} PerpetualState copy
      */
-    getPerpetualState(symbol: string, indexPriceInfo?: [number, number, boolean, boolean], overrides?: CallOverrides): Promise<PerpetualState>;
+    getPerpetualState(symbol: string, indexPriceInfo?: [number, number, boolean, boolean], overrides?: Overrides): Promise<PerpetualState>;
     /**
      * Query recent pool state from blockchain, not including perpetual states
      * @param {string} poolSymbol symbol of the form USDC
      * @returns {PoolState} PoolState copy
      */
-    getPoolState(poolSymbol: string, overrides?: CallOverrides): Promise<PoolState>;
+    getPoolState(poolSymbol: string, overrides?: Overrides): Promise<PoolState>;
     /**
      * Query perpetual static info.
      * This information is queried once at createProxyInstance-time, and remains static after that.
@@ -560,7 +559,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns {Order[]} Array of user friendly order struct.
      * @ignore
      */
-    protected static openOrdersOnOrderBook(traderAddr: string, orderBookContract: LimitOrderBook, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, overrides?: CallOverrides): Promise<Order[]>;
+    protected static openOrdersOnOrderBook(traderAddr: string, orderBookContract: LimitOrderBook, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, overrides?: Overrides): Promise<Order[]>;
     /**
      * Query smart contract to get user orders and convert to user friendly order format.
      * @param {string} traderAddr Address of trader.
@@ -568,7 +567,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns {Order[]} Array of user friendly order struct.
      * @ignore
      */
-    protected static _openOrdersOnOrderBooks(traderAddr: string, orderBookContracts: LimitOrderBook[], multicall: Multicall3, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, overrides?: CallOverrides): Promise<{
+    protected static _openOrdersOnOrderBooks(traderAddr: string, orderBookContracts: LimitOrderBook[], multicall: Multicall3, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, overrides?: Overrides): Promise<{
         orders: Order[][];
         digests: string[][];
     }>;
@@ -579,7 +578,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns Array of order-id's
      * @ignore
      */
-    static orderIdsOfTrader(traderAddr: string, orderBookContract: LimitOrderBook, overrides?: CallOverrides): Promise<string[]>;
+    static orderIdsOfTrader(traderAddr: string, orderBookContract: LimitOrderBook, overrides?: Overrides): Promise<string[]>;
     /**
      * Query the available margin conditional on the given (or current) index prices
      * Result is in collateral currency
@@ -601,7 +600,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getAvailableMargin(traderAddr: string, symbol: string, indexPrices?: [number, number], overrides?: CallOverrides): Promise<number>;
+    getAvailableMargin(traderAddr: string, symbol: string, indexPrices?: [number, number], overrides?: Overrides): Promise<number>;
     /**
      * Calculate a type of exchange loyality score based on trader volume
      * @param {string} traderAddr address of the trader
@@ -620,7 +619,7 @@ export default class MarketData extends PerpetualDataHandler {
      * }
      * main();
      */
-    getTraderLoyalityScore(traderAddr: string, overrides?: CallOverrides): Promise<number>;
+    getTraderLoyalityScore(traderAddr: string, overrides?: Overrides): Promise<number>;
     /**
      * Get all off-chain prices
      * @param _symbolToPerpStaticInfo mapping: PerpetualStaticInfo for each perpetual
@@ -705,7 +704,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @param overrides
      * @ignore
      */
-    static _exchangeInfo(_proxyContract: Contract, _multicall: Multicall3, _poolStaticInfos: Array<PoolStaticInfo>, _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _perpetualIdToSymbol: Map<number, string>, _nestedPerpetualIDs: Array<Array<number>>, _symbolList: Map<string, string>, _priceFeedGetter: PriceFeeds, _oracleFactoryAddr: string, overrides?: CallOverrides): Promise<ExchangeInfo>;
+    static _exchangeInfo(_proxyContract: Contract, _multicall: Multicall3, _poolStaticInfos: Array<PoolStaticInfo>, _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _perpetualIdToSymbol: Map<number, string>, _nestedPerpetualIDs: Array<Array<number>>, _symbolList: Map<string, string>, _priceFeedGetter: PriceFeeds, _oracleFactoryAddr: string, overrides?: Overrides): Promise<ExchangeInfo>;
     /**
      * Get the latest on-chain price of a perpetual base index in USD.
      * @param {string} symbol Symbol of the form ETH-USDC-MATIC.