@d8x/perpetuals-sdk 2.6.7 → 2.6.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/config/priceFeedConfig.json +51 -8
- package/dist/cjs/marketData.js +1 -0
- package/dist/cjs/marketData.js.map +1 -1
- package/dist/cjs/perpetualDataHandler.d.ts +2 -1
- package/dist/cjs/perpetualDataHandler.js +20 -4
- package/dist/cjs/perpetualDataHandler.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/config/priceFeedConfig.json +51 -8
- package/dist/esm/marketData.js +1 -0
- package/dist/esm/marketData.js.map +1 -1
- package/dist/esm/perpetualDataHandler.d.ts +2 -1
- package/dist/esm/perpetualDataHandler.js +21 -5
- package/dist/esm/perpetualDataHandler.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/doc/d8x-perpetuals-sdk.md +225 -71
- package/doc/perpetualDataHandler.md +49 -7
- package/package.json +1 -1
- package/src/config/priceFeedConfig.json +51 -9
- package/src/marketData.ts +1 -0
- package/src/perpetualDataHandler.ts +21 -4
- package/src/version.ts +1 -1
- package/dist/cjs/abi/AMMPerpLogic.json +0 -580
- package/dist/cjs/abi/BeaconProxy.json +0 -71
- package/dist/cjs/abi/IPerpetualManager copy.json +0 -5599
- package/dist/cjs/abi/IPerpetualMarginViewLogic.json +0 -286
- package/dist/cjs/abi/Maintainer.json +0 -774
- package/dist/cjs/abi/MockToken.json +0 -347
- package/dist/cjs/abi/MockUSD.json +0 -413
- package/dist/cjs/abi/UUPSUpgradeable.json +0 -104
- package/dist/cjs/abi/WeETH.json +0 -310
- package/dist/cjs/abi-zkevm/IPerpetualManager.json +0 -5366
- package/dist/cjs/abi-zkevm/LimitOrderBook.json +0 -910
- package/dist/cjs/abi-zkevm/LimitOrderBookFactory.json +0 -236
- package/dist/cjs/contracts/AMMPerpLogic.d.ts +0 -303
- package/dist/cjs/contracts/AMMPerpLogic.js +0 -3
- package/dist/cjs/contracts/AMMPerpLogic.js.map +0 -1
- package/dist/cjs/contracts/BeaconProxy.d.ts +0 -63
- package/dist/cjs/contracts/BeaconProxy.js +0 -3
- package/dist/cjs/contracts/BeaconProxy.js.map +0 -1
- package/dist/cjs/contracts/IPerpetualManagerCopy.d.ts +0 -3223
- package/dist/cjs/contracts/IPerpetualManagerCopy.js +0 -3
- package/dist/cjs/contracts/IPerpetualManagerCopy.js.map +0 -1
- package/dist/cjs/contracts/IPerpetualMarginViewLogic.d.ts +0 -183
- package/dist/cjs/contracts/IPerpetualMarginViewLogic.js +0 -3
- package/dist/cjs/contracts/IPerpetualMarginViewLogic.js.map +0 -1
- package/dist/cjs/contracts/Maintainer.d.ts +0 -799
- package/dist/cjs/contracts/Maintainer.js +0 -3
- package/dist/cjs/contracts/Maintainer.js.map +0 -1
- package/dist/cjs/contracts/MockToken.d.ts +0 -263
- package/dist/cjs/contracts/MockToken.js +0 -3
- package/dist/cjs/contracts/MockToken.js.map +0 -1
- package/dist/cjs/contracts/MockUSD.d.ts +0 -186
- package/dist/cjs/contracts/MockUSD.js +0 -3
- package/dist/cjs/contracts/MockUSD.js.map +0 -1
- package/dist/cjs/contracts/UUPSUpgradeable.d.ts +0 -118
- package/dist/cjs/contracts/UUPSUpgradeable.js +0 -3
- package/dist/cjs/contracts/UUPSUpgradeable.js.map +0 -1
- package/dist/cjs/contracts/WeETH.d.ts +0 -503
- package/dist/cjs/contracts/WeETH.js +0 -3
- package/dist/cjs/contracts/WeETH.js.map +0 -1
- package/dist/cjs/contracts/factories/AMMPerpLogic__factory.d.ts +0 -452
- package/dist/cjs/contracts/factories/AMMPerpLogic__factory.js +0 -598
- package/dist/cjs/contracts/factories/AMMPerpLogic__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/BeaconProxy__factory.d.ts +0 -61
- package/dist/cjs/contracts/factories/BeaconProxy__factory.js +0 -89
- package/dist/cjs/contracts/factories/BeaconProxy__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/IPerpetualManagerCopy__factory.d.ts +0 -4358
- package/dist/cjs/contracts/factories/IPerpetualManagerCopy__factory.js +0 -5617
- package/dist/cjs/contracts/factories/IPerpetualManagerCopy__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/IPerpetualMarginViewLogic__factory.d.ts +0 -221
- package/dist/cjs/contracts/factories/IPerpetualMarginViewLogic__factory.js +0 -304
- package/dist/cjs/contracts/factories/IPerpetualMarginViewLogic__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/Maintainer__factory.d.ts +0 -609
- package/dist/cjs/contracts/factories/Maintainer__factory.js +0 -792
- package/dist/cjs/contracts/factories/Maintainer__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/MockToken__factory.d.ts +0 -273
- package/dist/cjs/contracts/factories/MockToken__factory.js +0 -365
- package/dist/cjs/contracts/factories/MockToken__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/MockUSD__factory.d.ts +0 -320
- package/dist/cjs/contracts/factories/MockUSD__factory.js +0 -431
- package/dist/cjs/contracts/factories/MockUSD__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/UUPSUpgradeable__factory.d.ts +0 -87
- package/dist/cjs/contracts/factories/UUPSUpgradeable__factory.js +0 -122
- package/dist/cjs/contracts/factories/UUPSUpgradeable__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/WeETH__factory.d.ts +0 -545
- package/dist/cjs/contracts/factories/WeETH__factory.js +0 -721
- package/dist/cjs/contracts/factories/WeETH__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/lean0/IPerpetualManager__factory.d.ts +0 -4136
- package/dist/cjs/contracts/factories/lean0/IPerpetualManager__factory.js +0 -5324
- package/dist/cjs/contracts/factories/lean0/IPerpetualManager__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/lean0/LimitOrderBookFactory__factory.d.ts +0 -189
- package/dist/cjs/contracts/factories/lean0/LimitOrderBookFactory__factory.js +0 -254
- package/dist/cjs/contracts/factories/lean0/LimitOrderBookFactory__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/lean0/LimitOrderBook__factory.d.ts +0 -715
- package/dist/cjs/contracts/factories/lean0/LimitOrderBook__factory.js +0 -928
- package/dist/cjs/contracts/factories/lean0/LimitOrderBook__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/lean0/ShareToken__factory.d.ts +0 -344
- package/dist/cjs/contracts/factories/lean0/ShareToken__factory.js +0 -456
- package/dist/cjs/contracts/factories/lean0/ShareToken__factory.js.map +0 -1
- package/dist/cjs/contracts/factories/lean0/index.d.ts +0 -4
- package/dist/cjs/contracts/factories/lean0/index.js +0 -15
- package/dist/cjs/contracts/factories/lean0/index.js.map +0 -1
- package/dist/cjs/contracts/lean0/IPerpetualManager.d.ts +0 -2821
- package/dist/cjs/contracts/lean0/IPerpetualManager.js +0 -3
- package/dist/cjs/contracts/lean0/IPerpetualManager.js.map +0 -1
- package/dist/cjs/contracts/lean0/LimitOrderBook.d.ts +0 -533
- package/dist/cjs/contracts/lean0/LimitOrderBook.js +0 -3
- package/dist/cjs/contracts/lean0/LimitOrderBook.js.map +0 -1
- package/dist/cjs/contracts/lean0/LimitOrderBookFactory.d.ts +0 -210
- package/dist/cjs/contracts/lean0/LimitOrderBookFactory.js +0 -3
- package/dist/cjs/contracts/lean0/LimitOrderBookFactory.js.map +0 -1
- package/dist/cjs/contracts/lean0/ShareToken.d.ts +0 -320
- package/dist/cjs/contracts/lean0/ShareToken.js +0 -3
- package/dist/cjs/contracts/lean0/ShareToken.js.map +0 -1
- package/dist/cjs/contracts/lean0/index.d.ts +0 -4
- package/dist/cjs/contracts/lean0/index.js +0 -3
- package/dist/cjs/contracts/lean0/index.js.map +0 -1
- package/dist/esm/abi/AMMPerpLogic.json +0 -580
- package/dist/esm/abi/BeaconProxy.json +0 -71
- package/dist/esm/abi/IPerpetualManager copy.json +0 -5599
- package/dist/esm/abi/IPerpetualMarginViewLogic.json +0 -286
- package/dist/esm/abi/Maintainer.json +0 -774
- package/dist/esm/abi/MockToken.json +0 -347
- package/dist/esm/abi/MockUSD.json +0 -413
- package/dist/esm/abi/UUPSUpgradeable.json +0 -104
- package/dist/esm/abi/WeETH.json +0 -310
- package/dist/esm/abi/lean0/IPerpetualManager.json +0 -5306
- package/dist/esm/abi/lean0/LimitOrderBook.json +0 -910
- package/dist/esm/abi/lean0/LimitOrderBookFactory.json +0 -236
- package/dist/esm/abi/lean0/ShareToken.json +0 -438
- package/dist/esm/abi-zkevm/IPerpetualManager.json +0 -5366
- package/dist/esm/abi-zkevm/LimitOrderBook.json +0 -910
- package/dist/esm/abi-zkevm/LimitOrderBookFactory.json +0 -236
- package/dist/esm/contracts/AMMPerpLogic.d.ts +0 -303
- package/dist/esm/contracts/AMMPerpLogic.js +0 -2
- package/dist/esm/contracts/AMMPerpLogic.js.map +0 -1
- package/dist/esm/contracts/BeaconProxy.d.ts +0 -63
- package/dist/esm/contracts/BeaconProxy.js +0 -2
- package/dist/esm/contracts/BeaconProxy.js.map +0 -1
- package/dist/esm/contracts/IPerpetualManagerCopy.d.ts +0 -3223
- package/dist/esm/contracts/IPerpetualManagerCopy.js +0 -2
- package/dist/esm/contracts/IPerpetualManagerCopy.js.map +0 -1
- package/dist/esm/contracts/IPerpetualMarginViewLogic.d.ts +0 -183
- package/dist/esm/contracts/IPerpetualMarginViewLogic.js +0 -2
- package/dist/esm/contracts/IPerpetualMarginViewLogic.js.map +0 -1
- package/dist/esm/contracts/Maintainer.d.ts +0 -799
- package/dist/esm/contracts/Maintainer.js +0 -2
- package/dist/esm/contracts/Maintainer.js.map +0 -1
- package/dist/esm/contracts/MockToken.d.ts +0 -263
- package/dist/esm/contracts/MockToken.js +0 -2
- package/dist/esm/contracts/MockToken.js.map +0 -1
- package/dist/esm/contracts/MockUSD.d.ts +0 -186
- package/dist/esm/contracts/MockUSD.js +0 -2
- package/dist/esm/contracts/MockUSD.js.map +0 -1
- package/dist/esm/contracts/UUPSUpgradeable.d.ts +0 -118
- package/dist/esm/contracts/UUPSUpgradeable.js +0 -2
- package/dist/esm/contracts/UUPSUpgradeable.js.map +0 -1
- package/dist/esm/contracts/WeETH.d.ts +0 -503
- package/dist/esm/contracts/WeETH.js +0 -2
- package/dist/esm/contracts/WeETH.js.map +0 -1
- package/dist/esm/contracts/factories/AMMPerpLogic__factory.d.ts +0 -452
- package/dist/esm/contracts/factories/AMMPerpLogic__factory.js +0 -594
- package/dist/esm/contracts/factories/AMMPerpLogic__factory.js.map +0 -1
- package/dist/esm/contracts/factories/BeaconProxy__factory.d.ts +0 -61
- package/dist/esm/contracts/factories/BeaconProxy__factory.js +0 -85
- package/dist/esm/contracts/factories/BeaconProxy__factory.js.map +0 -1
- package/dist/esm/contracts/factories/IPerpetualManagerCopy__factory.d.ts +0 -4358
- package/dist/esm/contracts/factories/IPerpetualManagerCopy__factory.js +0 -5613
- package/dist/esm/contracts/factories/IPerpetualManagerCopy__factory.js.map +0 -1
- package/dist/esm/contracts/factories/IPerpetualMarginViewLogic__factory.d.ts +0 -221
- package/dist/esm/contracts/factories/IPerpetualMarginViewLogic__factory.js +0 -300
- package/dist/esm/contracts/factories/IPerpetualMarginViewLogic__factory.js.map +0 -1
- package/dist/esm/contracts/factories/Maintainer__factory.d.ts +0 -609
- package/dist/esm/contracts/factories/Maintainer__factory.js +0 -788
- package/dist/esm/contracts/factories/Maintainer__factory.js.map +0 -1
- package/dist/esm/contracts/factories/MockToken__factory.d.ts +0 -273
- package/dist/esm/contracts/factories/MockToken__factory.js +0 -361
- package/dist/esm/contracts/factories/MockToken__factory.js.map +0 -1
- package/dist/esm/contracts/factories/MockUSD__factory.d.ts +0 -320
- package/dist/esm/contracts/factories/MockUSD__factory.js +0 -427
- package/dist/esm/contracts/factories/MockUSD__factory.js.map +0 -1
- package/dist/esm/contracts/factories/UUPSUpgradeable__factory.d.ts +0 -87
- package/dist/esm/contracts/factories/UUPSUpgradeable__factory.js +0 -118
- package/dist/esm/contracts/factories/UUPSUpgradeable__factory.js.map +0 -1
- package/dist/esm/contracts/factories/WeETH__factory.d.ts +0 -545
- package/dist/esm/contracts/factories/WeETH__factory.js +0 -717
- package/dist/esm/contracts/factories/WeETH__factory.js.map +0 -1
- package/dist/esm/contracts/factories/lean0/IPerpetualManager__factory.d.ts +0 -4136
- package/dist/esm/contracts/factories/lean0/IPerpetualManager__factory.js +0 -5320
- package/dist/esm/contracts/factories/lean0/IPerpetualManager__factory.js.map +0 -1
- package/dist/esm/contracts/factories/lean0/LimitOrderBookFactory__factory.d.ts +0 -189
- package/dist/esm/contracts/factories/lean0/LimitOrderBookFactory__factory.js +0 -250
- package/dist/esm/contracts/factories/lean0/LimitOrderBookFactory__factory.js.map +0 -1
- package/dist/esm/contracts/factories/lean0/LimitOrderBook__factory.d.ts +0 -715
- package/dist/esm/contracts/factories/lean0/LimitOrderBook__factory.js +0 -924
- package/dist/esm/contracts/factories/lean0/LimitOrderBook__factory.js.map +0 -1
- package/dist/esm/contracts/factories/lean0/ShareToken__factory.d.ts +0 -344
- package/dist/esm/contracts/factories/lean0/ShareToken__factory.js +0 -452
- package/dist/esm/contracts/factories/lean0/ShareToken__factory.js.map +0 -1
- package/dist/esm/contracts/factories/lean0/index.d.ts +0 -4
- package/dist/esm/contracts/factories/lean0/index.js +0 -8
- package/dist/esm/contracts/factories/lean0/index.js.map +0 -1
- package/dist/esm/contracts/lean0/IPerpetualManager.d.ts +0 -2821
- package/dist/esm/contracts/lean0/IPerpetualManager.js +0 -2
- package/dist/esm/contracts/lean0/IPerpetualManager.js.map +0 -1
- package/dist/esm/contracts/lean0/LimitOrderBook.d.ts +0 -533
- package/dist/esm/contracts/lean0/LimitOrderBook.js +0 -2
- package/dist/esm/contracts/lean0/LimitOrderBook.js.map +0 -1
- package/dist/esm/contracts/lean0/LimitOrderBookFactory.d.ts +0 -210
- package/dist/esm/contracts/lean0/LimitOrderBookFactory.js +0 -2
- package/dist/esm/contracts/lean0/LimitOrderBookFactory.js.map +0 -1
- package/dist/esm/contracts/lean0/ShareToken.d.ts +0 -320
- package/dist/esm/contracts/lean0/ShareToken.js +0 -2
- package/dist/esm/contracts/lean0/ShareToken.js.map +0 -1
- package/dist/esm/contracts/lean0/index.d.ts +0 -4
- package/dist/esm/contracts/lean0/index.js +0 -2
- package/dist/esm/contracts/lean0/index.js.map +0 -1
- package/src/contracts/IPerpetualMarginViewLogic.ts +0 -347
- package/src/contracts/MockUSD.ts +0 -378
- package/src/contracts/factories/IPerpetualMarginViewLogic__factory.ts +0 -313
- package/src/contracts/factories/MockUSD__factory.ts +0 -430
|
@@ -761,7 +761,6 @@ require gas-payments.</p>
|
|
|
761
761
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
762
762
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
763
763
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
764
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
765
764
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
766
765
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
767
766
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -794,6 +793,8 @@ require gas-payments.</p>
|
|
|
794
793
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
795
794
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
796
795
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
796
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
797
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
797
798
|
|
|
798
799
|
<a name="new_AccountTrade_new"></a>
|
|
799
800
|
|
|
@@ -1081,13 +1082,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
1081
1082
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
1082
1083
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
1083
1084
|
|
|
1084
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
1085
|
-
|
|
1086
|
-
### accountTrade.fetchSymbolList()
|
|
1087
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
1088
|
-
|
|
1089
|
-
**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)
|
|
1090
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
1091
1085
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
1092
1086
|
|
|
1093
1087
|
### accountTrade.getOrderBookContract(symbol) ⇒
|
|
@@ -1549,6 +1543,26 @@ main();
|
|
|
1549
1543
|
| --- | --- |
|
|
1550
1544
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
1551
1545
|
|
|
1546
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
1547
|
+
|
|
1548
|
+
### accountTrade.getShortSymbol(symbol) ⇒
|
|
1549
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
1550
|
+
|
|
1551
|
+
**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)
|
|
1552
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
1553
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
1554
|
+
|
|
1555
|
+
| Param | Description |
|
|
1556
|
+
| --- | --- |
|
|
1557
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
1558
|
+
|
|
1559
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
1560
|
+
|
|
1561
|
+
### accountTrade.refreshSymbols()
|
|
1562
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
1563
|
+
|
|
1564
|
+
**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)
|
|
1565
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
1552
1566
|
<a name="BrokerTool"></a>
|
|
1553
1567
|
|
|
1554
1568
|
## BrokerTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
@@ -1577,7 +1591,6 @@ require gas-payments.</p>
|
|
|
1577
1591
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
1578
1592
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
1579
1593
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
1580
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
1581
1594
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
1582
1595
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
1583
1596
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -1610,6 +1623,8 @@ require gas-payments.</p>
|
|
|
1610
1623
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
1611
1624
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
1612
1625
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
1626
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
1627
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
1613
1628
|
|
|
1614
1629
|
<a name="new_BrokerTool_new"></a>
|
|
1615
1630
|
|
|
@@ -2081,13 +2096,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
2081
2096
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
2082
2097
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
2083
2098
|
|
|
2084
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
2085
|
-
|
|
2086
|
-
### brokerTool.fetchSymbolList()
|
|
2087
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
2088
|
-
|
|
2089
|
-
**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)
|
|
2090
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
2091
2099
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
2092
2100
|
|
|
2093
2101
|
### brokerTool.getOrderBookContract(symbol) ⇒
|
|
@@ -2549,6 +2557,26 @@ main();
|
|
|
2549
2557
|
| --- | --- |
|
|
2550
2558
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
2551
2559
|
|
|
2560
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
2561
|
+
|
|
2562
|
+
### brokerTool.getShortSymbol(symbol) ⇒
|
|
2563
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
2564
|
+
|
|
2565
|
+
**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)
|
|
2566
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
2567
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
2568
|
+
|
|
2569
|
+
| Param | Description |
|
|
2570
|
+
| --- | --- |
|
|
2571
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
2572
|
+
|
|
2573
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
2574
|
+
|
|
2575
|
+
### brokerTool.refreshSymbols()
|
|
2576
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
2577
|
+
|
|
2578
|
+
**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)
|
|
2579
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
2552
2580
|
<a name="LiquidatorTool"></a>
|
|
2553
2581
|
|
|
2554
2582
|
## LiquidatorTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
@@ -2569,7 +2597,6 @@ and executes smart-contract interactions that require gas-payments.</p>
|
|
|
2569
2597
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
2570
2598
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
2571
2599
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
2572
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
2573
2600
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
2574
2601
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
2575
2602
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -2602,6 +2629,8 @@ and executes smart-contract interactions that require gas-payments.</p>
|
|
|
2602
2629
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
2603
2630
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
2604
2631
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
2632
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
2633
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
2605
2634
|
|
|
2606
2635
|
<a name="new_LiquidatorTool_new"></a>
|
|
2607
2636
|
|
|
@@ -2831,13 +2860,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
2831
2860
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
2832
2861
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
2833
2862
|
|
|
2834
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
2835
|
-
|
|
2836
|
-
### liquidatorTool.fetchSymbolList()
|
|
2837
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
2838
|
-
|
|
2839
|
-
**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)
|
|
2840
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
2841
2863
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
2842
2864
|
|
|
2843
2865
|
### liquidatorTool.getOrderBookContract(symbol) ⇒
|
|
@@ -3299,6 +3321,26 @@ main();
|
|
|
3299
3321
|
| --- | --- |
|
|
3300
3322
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
3301
3323
|
|
|
3324
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
3325
|
+
|
|
3326
|
+
### liquidatorTool.getShortSymbol(symbol) ⇒
|
|
3327
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
3328
|
+
|
|
3329
|
+
**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)
|
|
3330
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
3331
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
3332
|
+
|
|
3333
|
+
| Param | Description |
|
|
3334
|
+
| --- | --- |
|
|
3335
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
3336
|
+
|
|
3337
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
3338
|
+
|
|
3339
|
+
### liquidatorTool.refreshSymbols()
|
|
3340
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
3341
|
+
|
|
3342
|
+
**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)
|
|
3343
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
3302
3344
|
<a name="LiquidityProviderTool"></a>
|
|
3303
3345
|
|
|
3304
3346
|
## LiquidityProviderTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
@@ -3317,7 +3359,6 @@ smart-contract interactions that require gas-payments.</p>
|
|
|
3317
3359
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
3318
3360
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
3319
3361
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
3320
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
3321
3362
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
3322
3363
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
3323
3364
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -3350,6 +3391,8 @@ smart-contract interactions that require gas-payments.</p>
|
|
|
3350
3391
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
3351
3392
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
3352
3393
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
3394
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
3395
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
3353
3396
|
|
|
3354
3397
|
<a name="new_LiquidityProviderTool_new"></a>
|
|
3355
3398
|
|
|
@@ -3518,13 +3561,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
3518
3561
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
3519
3562
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
3520
3563
|
|
|
3521
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
3522
|
-
|
|
3523
|
-
### liquidityProviderTool.fetchSymbolList()
|
|
3524
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
3525
|
-
|
|
3526
|
-
**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)
|
|
3527
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
3528
3564
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
3529
3565
|
|
|
3530
3566
|
### liquidityProviderTool.getOrderBookContract(symbol) ⇒
|
|
@@ -3986,6 +4022,26 @@ main();
|
|
|
3986
4022
|
| --- | --- |
|
|
3987
4023
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
3988
4024
|
|
|
4025
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
4026
|
+
|
|
4027
|
+
### liquidityProviderTool.getShortSymbol(symbol) ⇒
|
|
4028
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
4029
|
+
|
|
4030
|
+
**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)
|
|
4031
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
4032
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
4033
|
+
|
|
4034
|
+
| Param | Description |
|
|
4035
|
+
| --- | --- |
|
|
4036
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
4037
|
+
|
|
4038
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
4039
|
+
|
|
4040
|
+
### liquidityProviderTool.refreshSymbols()
|
|
4041
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
4042
|
+
|
|
4043
|
+
**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)
|
|
4044
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
3989
4045
|
<a name="MarketData"></a>
|
|
3990
4046
|
|
|
3991
4047
|
## MarketData ⇐ [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
@@ -4034,7 +4090,6 @@ No gas required for the queries here.</p>
|
|
|
4034
4090
|
* [.fetchPricesForPerpetual(symbol)](#MarketData+fetchPricesForPerpetual) ⇒
|
|
4035
4091
|
* [.fetchPrdMktMetaData(symbol)](#MarketData+fetchPrdMktMetaData) ⇒
|
|
4036
4092
|
* [.fetchPythMetaData(symbol)](#MarketData+fetchPythMetaData) ⇒
|
|
4037
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
4038
4093
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
4039
4094
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
4040
4095
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -4067,6 +4122,8 @@ No gas required for the queries here.</p>
|
|
|
4067
4122
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
4068
4123
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
4069
4124
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
4125
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
4126
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
4070
4127
|
* _static_
|
|
4071
4128
|
* [.exchangeFeePrdMkts(maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate)](#MarketData.exchangeFeePrdMkts) ⇒
|
|
4072
4129
|
|
|
@@ -4879,13 +4936,6 @@ The priority is:</p>
|
|
|
4879
4936
|
| --- | --- |
|
|
4880
4937
|
| symbol | <p>symbol of the form "BERA-USD"</p> |
|
|
4881
4938
|
|
|
4882
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
4883
|
-
|
|
4884
|
-
### marketData.fetchSymbolList()
|
|
4885
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
4886
|
-
|
|
4887
|
-
**Kind**: instance method of [<code>MarketData</code>](#MarketData)
|
|
4888
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
4889
4939
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
4890
4940
|
|
|
4891
4941
|
### marketData.getOrderBookContract(symbol) ⇒
|
|
@@ -5347,6 +5397,26 @@ main();
|
|
|
5347
5397
|
| --- | --- |
|
|
5348
5398
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
5349
5399
|
|
|
5400
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
5401
|
+
|
|
5402
|
+
### marketData.getShortSymbol(symbol) ⇒
|
|
5403
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
5404
|
+
|
|
5405
|
+
**Kind**: instance method of [<code>MarketData</code>](#MarketData)
|
|
5406
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
5407
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
5408
|
+
|
|
5409
|
+
| Param | Description |
|
|
5410
|
+
| --- | --- |
|
|
5411
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
5412
|
+
|
|
5413
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
5414
|
+
|
|
5415
|
+
### marketData.refreshSymbols()
|
|
5416
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
5417
|
+
|
|
5418
|
+
**Kind**: instance method of [<code>MarketData</code>](#MarketData)
|
|
5419
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
5350
5420
|
<a name="MarketData.exchangeFeePrdMkts"></a>
|
|
5351
5421
|
|
|
5352
5422
|
### MarketData.exchangeFeePrdMkts(maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate) ⇒
|
|
@@ -5403,7 +5473,6 @@ gas-payments.</p>
|
|
|
5403
5473
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
5404
5474
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
5405
5475
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
5406
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
5407
5476
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
5408
5477
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
5409
5478
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -5436,6 +5505,8 @@ gas-payments.</p>
|
|
|
5436
5505
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
5437
5506
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
5438
5507
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
5508
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
5509
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
5439
5510
|
|
|
5440
5511
|
<a name="new_OrderExecutorTool_new"></a>
|
|
5441
5512
|
|
|
@@ -5711,13 +5782,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
5711
5782
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
5712
5783
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
5713
5784
|
|
|
5714
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
5715
|
-
|
|
5716
|
-
### orderExecutorTool.fetchSymbolList()
|
|
5717
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
5718
|
-
|
|
5719
|
-
**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)
|
|
5720
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
5721
5785
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
5722
5786
|
|
|
5723
5787
|
### orderExecutorTool.getOrderBookContract(symbol) ⇒
|
|
@@ -6179,6 +6243,26 @@ main();
|
|
|
6179
6243
|
| --- | --- |
|
|
6180
6244
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
6181
6245
|
|
|
6246
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
6247
|
+
|
|
6248
|
+
### orderExecutorTool.getShortSymbol(symbol) ⇒
|
|
6249
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
6250
|
+
|
|
6251
|
+
**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)
|
|
6252
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
6253
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
6254
|
+
|
|
6255
|
+
| Param | Description |
|
|
6256
|
+
| --- | --- |
|
|
6257
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
6258
|
+
|
|
6259
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
6260
|
+
|
|
6261
|
+
### orderExecutorTool.refreshSymbols()
|
|
6262
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
6263
|
+
|
|
6264
|
+
**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)
|
|
6265
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
6182
6266
|
<a name="PerpetualDataHandler"></a>
|
|
6183
6267
|
|
|
6184
6268
|
## PerpetualDataHandler
|
|
@@ -6190,7 +6274,6 @@ common data and chain operations.</p>
|
|
|
6190
6274
|
* [PerpetualDataHandler](#PerpetualDataHandler)
|
|
6191
6275
|
* [new PerpetualDataHandler(config)](#new_PerpetualDataHandler_new)
|
|
6192
6276
|
* _instance_
|
|
6193
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
6194
6277
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
6195
6278
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
6196
6279
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -6223,7 +6306,10 @@ common data and chain operations.</p>
|
|
|
6223
6306
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
6224
6307
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
6225
6308
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
6309
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
6310
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
6226
6311
|
* _static_
|
|
6312
|
+
* [.fetchSymbolList(chainId, short)](#PerpetualDataHandler.fetchSymbolList) ⇒
|
|
6227
6313
|
* [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒
|
|
6228
6314
|
* [.nestedIDsToChunks(chunkSize, nestedIDs)](#PerpetualDataHandler.nestedIDsToChunks) ⇒ <code>Array.<Array.<number>></code>
|
|
6229
6315
|
* [._getLiquidityPools(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getLiquidityPools) ⇒
|
|
@@ -6252,6 +6338,7 @@ common data and chain operations.</p>
|
|
|
6252
6338
|
* [.getInitialMarginRate(staticInfo)](#PerpetualDataHandler.getInitialMarginRate) ⇒
|
|
6253
6339
|
* [.getMaintenanceMarginRate(staticInfo)](#PerpetualDataHandler.getMaintenanceMarginRate) ⇒
|
|
6254
6340
|
* [.isMarketDayTime(fAMMTargetDD)](#PerpetualDataHandler.isMarketDayTime) ⇒
|
|
6341
|
+
* [.getIndexSymbol(_symbolList, info)](#PerpetualDataHandler.getIndexSymbol) ⇒
|
|
6255
6342
|
|
|
6256
6343
|
<a name="new_PerpetualDataHandler_new"></a>
|
|
6257
6344
|
|
|
@@ -6263,12 +6350,6 @@ common data and chain operations.</p>
|
|
|
6263
6350
|
| --- | --- | --- |
|
|
6264
6351
|
| config | <code>NodeSDKConfig</code> | <p>Configuration object, see PerpetualDataHandler.readSDKConfig.</p> |
|
|
6265
6352
|
|
|
6266
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
6267
|
-
|
|
6268
|
-
### perpetualDataHandler.fetchSymbolList()
|
|
6269
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
6270
|
-
|
|
6271
|
-
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
6272
6353
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
6273
6354
|
|
|
6274
6355
|
### perpetualDataHandler.getOrderBookContract(symbol) ⇒
|
|
@@ -6698,6 +6779,38 @@ main();
|
|
|
6698
6779
|
| --- | --- |
|
|
6699
6780
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
6700
6781
|
|
|
6782
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
6783
|
+
|
|
6784
|
+
### perpetualDataHandler.getShortSymbol(symbol) ⇒
|
|
6785
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
6786
|
+
|
|
6787
|
+
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
6788
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
6789
|
+
|
|
6790
|
+
| Param | Description |
|
|
6791
|
+
| --- | --- |
|
|
6792
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
6793
|
+
|
|
6794
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
6795
|
+
|
|
6796
|
+
### perpetualDataHandler.refreshSymbols()
|
|
6797
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
6798
|
+
|
|
6799
|
+
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
6800
|
+
<a name="PerpetualDataHandler.fetchSymbolList"></a>
|
|
6801
|
+
|
|
6802
|
+
### PerpetualDataHandler.fetchSymbolList(chainId, short) ⇒
|
|
6803
|
+
<p>Fetch list of {short,long} symbols from API.
|
|
6804
|
+
Symbol is left unchanged if unknown.</p>
|
|
6805
|
+
|
|
6806
|
+
**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
6807
|
+
**Returns**: <p>List of long perp symbols</p>
|
|
6808
|
+
|
|
6809
|
+
| Param | Description |
|
|
6810
|
+
| --- | --- |
|
|
6811
|
+
| chainId | <p>Chain id</p> |
|
|
6812
|
+
| short | <p>List of short perp symbols (<=4 chars)</p> |
|
|
6813
|
+
|
|
6701
6814
|
<a name="PerpetualDataHandler.getPerpetualStaticInfo"></a>
|
|
6702
6815
|
|
|
6703
6816
|
### PerpetualDataHandler.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList) ⇒
|
|
@@ -7084,6 +7197,19 @@ which has open/close times</p>
|
|
|
7084
7197
|
| --- | --- |
|
|
7085
7198
|
| fAMMTargetDD | <p>bigint that encodes market day trading times</p> |
|
|
7086
7199
|
|
|
7200
|
+
<a name="PerpetualDataHandler.getIndexSymbol"></a>
|
|
7201
|
+
|
|
7202
|
+
### PerpetualDataHandler.getIndexSymbol(_symbolList, info) ⇒
|
|
7203
|
+
<p>Static function to get index symbol from perp static info</p>
|
|
7204
|
+
|
|
7205
|
+
**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
7206
|
+
**Returns**: <p>Index symbol</p>
|
|
7207
|
+
|
|
7208
|
+
| Param | Description |
|
|
7209
|
+
| --- | --- |
|
|
7210
|
+
| _symbolList | <p>Mapping from long symbol (e.g. NHL_TOR_DAL_251015) to price-feed API symbol (NHL0-USD:84532)</p> |
|
|
7211
|
+
| info | <p>Perpetual static info</p> |
|
|
7212
|
+
|
|
7087
7213
|
<a name="PerpetualEventHandler"></a>
|
|
7088
7214
|
|
|
7089
7215
|
## PerpetualEventHandler
|
|
@@ -7805,7 +7931,6 @@ so that signatures can be handled in frontend via wallet</p>
|
|
|
7805
7931
|
* [.fetchPricesForPerpetual(symbol)](#MarketData+fetchPricesForPerpetual) ⇒
|
|
7806
7932
|
* [.fetchPrdMktMetaData(symbol)](#MarketData+fetchPrdMktMetaData) ⇒
|
|
7807
7933
|
* [.fetchPythMetaData(symbol)](#MarketData+fetchPythMetaData) ⇒
|
|
7808
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
7809
7934
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
7810
7935
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
7811
7936
|
* [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
|
|
@@ -7837,6 +7962,8 @@ so that signatures can be handled in frontend via wallet</p>
|
|
|
7837
7962
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
7838
7963
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
7839
7964
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
7965
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
7966
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
7840
7967
|
* _static_
|
|
7841
7968
|
* [.chainOrders(orders, ids)](#TraderInterface.chainOrders) ⇒
|
|
7842
7969
|
|
|
@@ -8923,13 +9050,6 @@ The priority is:</p>
|
|
|
8923
9050
|
| --- | --- |
|
|
8924
9051
|
| symbol | <p>symbol of the form "BERA-USD"</p> |
|
|
8925
9052
|
|
|
8926
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
8927
|
-
|
|
8928
|
-
### traderInterface.fetchSymbolList()
|
|
8929
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
8930
|
-
|
|
8931
|
-
**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)
|
|
8932
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
8933
9053
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
8934
9054
|
|
|
8935
9055
|
### traderInterface.getOrderBookContract(symbol) ⇒
|
|
@@ -9378,6 +9498,26 @@ main();
|
|
|
9378
9498
|
| --- | --- |
|
|
9379
9499
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
9380
9500
|
|
|
9501
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
9502
|
+
|
|
9503
|
+
### traderInterface.getShortSymbol(symbol) ⇒
|
|
9504
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
9505
|
+
|
|
9506
|
+
**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)
|
|
9507
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
9508
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
9509
|
+
|
|
9510
|
+
| Param | Description |
|
|
9511
|
+
| --- | --- |
|
|
9512
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
9513
|
+
|
|
9514
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
9515
|
+
|
|
9516
|
+
### traderInterface.refreshSymbols()
|
|
9517
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
9518
|
+
|
|
9519
|
+
**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)
|
|
9520
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
9381
9521
|
<a name="TraderInterface.chainOrders"></a>
|
|
9382
9522
|
|
|
9383
9523
|
### TraderInterface.chainOrders(orders, ids) ⇒
|
|
@@ -9409,7 +9549,6 @@ require gas-payments.</p>
|
|
|
9409
9549
|
* [.setAllowance(symbol, amount)](#WriteAccessHandler+setAllowance) ⇒
|
|
9410
9550
|
* [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
|
|
9411
9551
|
* [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
|
|
9412
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
9413
9552
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
9414
9553
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
9415
9554
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -9442,6 +9581,8 @@ require gas-payments.</p>
|
|
|
9442
9581
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
9443
9582
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
9444
9583
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
9584
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
9585
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
9445
9586
|
|
|
9446
9587
|
<a name="new_WriteAccessHandler_new"></a>
|
|
9447
9588
|
|
|
@@ -9500,13 +9641,6 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
|
|
|
9500
9641
|
| symbol | <p>Pool margin token e.g. MATIC</p> |
|
|
9501
9642
|
| amountToPay | <p>Amount in chain currency, e.g. "0.1" for 0.1 MATIC</p> |
|
|
9502
9643
|
|
|
9503
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
9504
|
-
|
|
9505
|
-
### writeAccessHandler.fetchSymbolList()
|
|
9506
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
9507
|
-
|
|
9508
|
-
**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
9509
|
-
**Overrides**: [<code>fetchSymbolList</code>](#PerpetualDataHandler+fetchSymbolList)
|
|
9510
9644
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
9511
9645
|
|
|
9512
9646
|
### writeAccessHandler.getOrderBookContract(symbol) ⇒
|
|
@@ -9968,6 +10102,26 @@ main();
|
|
|
9968
10102
|
| --- | --- |
|
|
9969
10103
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
9970
10104
|
|
|
10105
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
10106
|
+
|
|
10107
|
+
### writeAccessHandler.getShortSymbol(symbol) ⇒
|
|
10108
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
10109
|
+
|
|
10110
|
+
**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
10111
|
+
**Overrides**: [<code>getShortSymbol</code>](#PerpetualDataHandler+getShortSymbol)
|
|
10112
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
10113
|
+
|
|
10114
|
+
| Param | Description |
|
|
10115
|
+
| --- | --- |
|
|
10116
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
10117
|
+
|
|
10118
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
10119
|
+
|
|
10120
|
+
### writeAccessHandler.refreshSymbols()
|
|
10121
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
10122
|
+
|
|
10123
|
+
**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)
|
|
10124
|
+
**Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)
|
|
9971
10125
|
<a name="default"></a>
|
|
9972
10126
|
|
|
9973
10127
|
## default ⇒
|
|
@@ -9,7 +9,6 @@ common data and chain operations.</p>
|
|
|
9
9
|
* [PerpetualDataHandler](#PerpetualDataHandler)
|
|
10
10
|
* [new PerpetualDataHandler(config)](#new_PerpetualDataHandler_new)
|
|
11
11
|
* _instance_
|
|
12
|
-
* [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
|
|
13
12
|
* [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
|
|
14
13
|
* [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
|
|
15
14
|
* [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
|
|
@@ -42,7 +41,10 @@ common data and chain operations.</p>
|
|
|
42
41
|
* [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒
|
|
43
42
|
* [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒
|
|
44
43
|
* [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
|
|
44
|
+
* [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
|
|
45
|
+
* [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
|
|
45
46
|
* _static_
|
|
47
|
+
* [.fetchSymbolList(chainId, short)](#PerpetualDataHandler.fetchSymbolList) ⇒
|
|
46
48
|
* [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒
|
|
47
49
|
* [.nestedIDsToChunks(chunkSize, nestedIDs)](#PerpetualDataHandler.nestedIDsToChunks) ⇒ <code>Array.<Array.<number>></code>
|
|
48
50
|
* [._getLiquidityPools(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getLiquidityPools) ⇒
|
|
@@ -71,6 +73,7 @@ common data and chain operations.</p>
|
|
|
71
73
|
* [.getInitialMarginRate(staticInfo)](#PerpetualDataHandler.getInitialMarginRate) ⇒
|
|
72
74
|
* [.getMaintenanceMarginRate(staticInfo)](#PerpetualDataHandler.getMaintenanceMarginRate) ⇒
|
|
73
75
|
* [.isMarketDayTime(fAMMTargetDD)](#PerpetualDataHandler.isMarketDayTime) ⇒
|
|
76
|
+
* [.getIndexSymbol(_symbolList, info)](#PerpetualDataHandler.getIndexSymbol) ⇒
|
|
74
77
|
|
|
75
78
|
<a name="new_PerpetualDataHandler_new"></a>
|
|
76
79
|
|
|
@@ -82,12 +85,6 @@ common data and chain operations.</p>
|
|
|
82
85
|
| --- | --- | --- |
|
|
83
86
|
| config | <code>NodeSDKConfig</code> | <p>Configuration object, see PerpetualDataHandler.readSDKConfig.</p> |
|
|
84
87
|
|
|
85
|
-
<a name="PerpetualDataHandler+fetchSymbolList"></a>
|
|
86
|
-
|
|
87
|
-
### perpetualDataHandler.fetchSymbolList()
|
|
88
|
-
<p>sets the symbollist if a remote config url is specified</p>
|
|
89
|
-
|
|
90
|
-
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
91
88
|
<a name="PerpetualDataHandler+getOrderBookContract"></a>
|
|
92
89
|
|
|
93
90
|
### perpetualDataHandler.getOrderBookContract(symbol) ⇒
|
|
@@ -517,6 +514,38 @@ main();
|
|
|
517
514
|
| --- | --- |
|
|
518
515
|
| symbol | <p>perpetual symbol MSTR-USD-BUSD</p> |
|
|
519
516
|
|
|
517
|
+
<a name="PerpetualDataHandler+getShortSymbol"></a>
|
|
518
|
+
|
|
519
|
+
### perpetualDataHandler.getShortSymbol(symbol) ⇒
|
|
520
|
+
<p>Short symbol corresponding to a given long symbol.</p>
|
|
521
|
+
|
|
522
|
+
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
523
|
+
**Returns**: <p>Short symbol (e.g. NHL0)</p>
|
|
524
|
+
|
|
525
|
+
| Param | Description |
|
|
526
|
+
| --- | --- |
|
|
527
|
+
| symbol | <p>Long symbol (e.g. NHL_TOR_DAL_251015)</p> |
|
|
528
|
+
|
|
529
|
+
<a name="PerpetualDataHandler+refreshSymbols"></a>
|
|
530
|
+
|
|
531
|
+
### perpetualDataHandler.refreshSymbols()
|
|
532
|
+
<p>Refreshes symbol mappings if at least one prediction market is expired</p>
|
|
533
|
+
|
|
534
|
+
**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
535
|
+
<a name="PerpetualDataHandler.fetchSymbolList"></a>
|
|
536
|
+
|
|
537
|
+
### PerpetualDataHandler.fetchSymbolList(chainId, short) ⇒
|
|
538
|
+
<p>Fetch list of {short,long} symbols from API.
|
|
539
|
+
Symbol is left unchanged if unknown.</p>
|
|
540
|
+
|
|
541
|
+
**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
542
|
+
**Returns**: <p>List of long perp symbols</p>
|
|
543
|
+
|
|
544
|
+
| Param | Description |
|
|
545
|
+
| --- | --- |
|
|
546
|
+
| chainId | <p>Chain id</p> |
|
|
547
|
+
| short | <p>List of short perp symbols (<=4 chars)</p> |
|
|
548
|
+
|
|
520
549
|
<a name="PerpetualDataHandler.getPerpetualStaticInfo"></a>
|
|
521
550
|
|
|
522
551
|
### PerpetualDataHandler.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList) ⇒
|
|
@@ -903,3 +932,16 @@ which has open/close times</p>
|
|
|
903
932
|
| --- | --- |
|
|
904
933
|
| fAMMTargetDD | <p>bigint that encodes market day trading times</p> |
|
|
905
934
|
|
|
935
|
+
<a name="PerpetualDataHandler.getIndexSymbol"></a>
|
|
936
|
+
|
|
937
|
+
### PerpetualDataHandler.getIndexSymbol(_symbolList, info) ⇒
|
|
938
|
+
<p>Static function to get index symbol from perp static info</p>
|
|
939
|
+
|
|
940
|
+
**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
|
|
941
|
+
**Returns**: <p>Index symbol</p>
|
|
942
|
+
|
|
943
|
+
| Param | Description |
|
|
944
|
+
| --- | --- |
|
|
945
|
+
| _symbolList | <p>Mapping from long symbol (e.g. NHL_TOR_DAL_251015) to price-feed API symbol (NHL0-USD:84532)</p> |
|
|
946
|
+
| info | <p>Perpetual static info</p> |
|
|
947
|
+
|