npm - @d8x/perpetuals-sdk - Versions diffs - 0.2.2 → 0.3.0 - Mend

@d8x/perpetuals-sdk 0.2.2 → 0.3.0

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.

Files changed (32) hide show

package/dist/cjs/abi/central-park/IPerpetualManager.json +142 -12
package/dist/cjs/abi/testnet/IPerpetualManager.json +130 -0
package/dist/cjs/abi/zkevmTestnet/IPerpetualManager.json +130 -0
package/dist/cjs/config/defaultConfig.json +0 -11
package/dist/cjs/marketData.d.ts +1 -1
package/dist/cjs/marketData.js +25 -27
package/dist/cjs/marketData.js.map +1 -1
package/dist/cjs/nodeSDKTypes.d.ts +3 -1
package/dist/cjs/nodeSDKTypes.js +1 -1
package/dist/cjs/nodeSDKTypes.js.map +1 -1
package/dist/cjs/perpetualDataHandler.d.ts +22 -1
package/dist/cjs/perpetualDataHandler.js +155 -156
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/abi/central-park/IPerpetualManager.json +142 -12
package/dist/esm/abi/testnet/IPerpetualManager.json +130 -0
package/dist/esm/abi/zkevmTestnet/IPerpetualManager.json +130 -0
package/dist/esm/config/defaultConfig.json +0 -11
package/dist/esm/marketData.d.ts +1 -1
package/dist/esm/marketData.js +25 -27
package/dist/esm/marketData.js.map +1 -1
package/dist/esm/nodeSDKTypes.d.ts +3 -1
package/dist/esm/nodeSDKTypes.js +1 -1
package/dist/esm/nodeSDKTypes.js.map +1 -1
package/dist/esm/perpetualDataHandler.d.ts +22 -1
package/dist/esm/perpetualDataHandler.js +155 -156
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 +29 -0
package/package.json +1 -1

package/dist/cjs/abi/central-park/IPerpetualManager.json CHANGED Viewed

@@ -901,7 +901,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -1837,7 +1837,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -2079,7 +2079,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -2188,7 +2188,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -2279,7 +2279,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -2965,7 +2965,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "iLastOpenBlock",
+                        "name": "iLastOpenTimestamp",
                         "type": "uint64"
                     },
                     {
@@ -3129,7 +3129,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "iLastSettlementPriceUpdateBlock",
+                        "name": "iLastSettlementPriceUpdateTimestamp",
                         "type": "uint64"
                     },
                     {
@@ -3321,7 +3321,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "iLastPriceJumpBlock",
+                        "name": "iLastPriceJumpTimestamp",
                         "type": "uint64"
                     },
                     {
@@ -3411,6 +3411,97 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint24[]",
+                "name": "perpetualIds",
+                "type": "uint24[]"
+            }
+        ],
+        "name": "getPerpetualStaticInfo",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "uint24",
+                        "name": "id",
+                        "type": "uint24"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "limitOrderBookAddr",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fInitialMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fMaintenanceMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "uint8",
+                        "name": "perpetualState",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "enum AMMPerpLogic.CollateralCurrency",
+                        "name": "collCurrencyType",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fLotSizeBC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fReferralRebateCC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "bytes32[]",
+                        "name": "priceIds",
+                        "type": "bytes32[]"
+                    },
+                    {
+                        "internalType": "bool[]",
+                        "name": "isPyth",
+                        "type": "bool[]"
+                    }
+                ],
+                "internalType": "struct IPerpetualGetter.PerpetualStaticInfo[]",
+                "name": "",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [],
         "name": "getPoolCount",
@@ -3443,6 +3534,45 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolFromIdx",
+                "type": "uint8"
+            },
+            {
+                "internalType": "uint8",
+                "name": "_poolToIdx",
+                "type": "uint8"
+            }
+        ],
+        "name": "getPoolStaticInfo",
+        "outputs": [
+            {
+                "internalType": "uint24[][]",
+                "name": "",
+                "type": "uint24[][]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address",
+                "name": "_oracleFactoryAddress",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [
             {
@@ -4015,7 +4145,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -4182,7 +4312,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -4817,7 +4947,7 @@
                     },
                     {
                         "internalType": "uint64",
-                        "name": "submittedBlock",
+                        "name": "submittedTimestamp",
                         "type": "uint64"
                     }
                 ],
@@ -5008,7 +5138,7 @@
             },
             {
                 "internalType": "uint256",
-                "name": "_blockAge",
+                "name": "_maxAcceptableFeedAge",
                 "type": "uint256"
             }
         ],

package/dist/cjs/abi/testnet/IPerpetualManager.json CHANGED Viewed

@@ -3411,6 +3411,97 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint24[]",
+                "name": "perpetualIds",
+                "type": "uint24[]"
+            }
+        ],
+        "name": "getPerpetualStaticInfo",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "uint24",
+                        "name": "id",
+                        "type": "uint24"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "limitOrderBookAddr",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fInitialMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fMaintenanceMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "uint8",
+                        "name": "perpetualState",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "enum AMMPerpLogic.CollateralCurrency",
+                        "name": "collCurrencyType",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fLotSizeBC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fReferralRebateCC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "bytes32[]",
+                        "name": "priceIds",
+                        "type": "bytes32[]"
+                    },
+                    {
+                        "internalType": "bool[]",
+                        "name": "isPyth",
+                        "type": "bool[]"
+                    }
+                ],
+                "internalType": "struct IPerpetualGetter.PerpetualStaticInfo[]",
+                "name": "",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [],
         "name": "getPoolCount",
@@ -3443,6 +3534,45 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolFromIdx",
+                "type": "uint8"
+            },
+            {
+                "internalType": "uint8",
+                "name": "_poolToIdx",
+                "type": "uint8"
+            }
+        ],
+        "name": "getPoolStaticInfo",
+        "outputs": [
+            {
+                "internalType": "uint24[][]",
+                "name": "",
+                "type": "uint24[][]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address",
+                "name": "_oracleFactoryAddress",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [
             {

package/dist/cjs/abi/zkevmTestnet/IPerpetualManager.json CHANGED Viewed

@@ -3411,6 +3411,97 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint24[]",
+                "name": "perpetualIds",
+                "type": "uint24[]"
+            }
+        ],
+        "name": "getPerpetualStaticInfo",
+        "outputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "uint24",
+                        "name": "id",
+                        "type": "uint24"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "limitOrderBookAddr",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fInitialMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fMaintenanceMarginRate",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "uint8",
+                        "name": "perpetualState",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "enum AMMPerpLogic.CollateralCurrency",
+                        "name": "collCurrencyType",
+                        "type": "uint8"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S2QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3BaseCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "bytes4",
+                        "name": "S3QuoteCCY",
+                        "type": "bytes4"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fLotSizeBC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "int128",
+                        "name": "fReferralRebateCC",
+                        "type": "int128"
+                    },
+                    {
+                        "internalType": "bytes32[]",
+                        "name": "priceIds",
+                        "type": "bytes32[]"
+                    },
+                    {
+                        "internalType": "bool[]",
+                        "name": "isPyth",
+                        "type": "bool[]"
+                    }
+                ],
+                "internalType": "struct IPerpetualGetter.PerpetualStaticInfo[]",
+                "name": "",
+                "type": "tuple[]"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [],
         "name": "getPoolCount",
@@ -3443,6 +3534,45 @@
         "stateMutability": "view",
         "type": "function"
     },
+    {
+        "inputs": [
+            {
+                "internalType": "uint8",
+                "name": "_poolFromIdx",
+                "type": "uint8"
+            },
+            {
+                "internalType": "uint8",
+                "name": "_poolToIdx",
+                "type": "uint8"
+            }
+        ],
+        "name": "getPoolStaticInfo",
+        "outputs": [
+            {
+                "internalType": "uint24[][]",
+                "name": "",
+                "type": "uint24[][]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address[]",
+                "name": "",
+                "type": "address[]"
+            },
+            {
+                "internalType": "address",
+                "name": "_oracleFactoryAddress",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
     {
         "inputs": [
             {

package/dist/cjs/config/defaultConfig.json CHANGED Viewed

@@ -22,17 +22,6 @@
         "limitOrderBookFactoryABILocation": "",
         "limitOrderBookABILocation": ""
     },
-    {
-        "name": "central-park",
-        "chainId": 80001,
-        "version": 5.1,
-        "proxyAddr": "0x4F1C7EE9E881Cc735f39Ca36c649ba9E930B4E4e",
-        "nodeURL": "https://polygon-mumbai.blockpi.network/v1/rpc/public",
-        "priceFeedConfigNetwork": "testnet",
-        "proxyABILocation": "central-park/IPerpetualManager.json",
-        "limitOrderBookFactoryABILocation": "central-park/LimitOrderBookFactory.json",
-        "limitOrderBookABILocation": "central-park/LimitOrderBook.json"
-    },
     {
         "name": "zkevmTestnet",
         "chainId": 1442,

package/dist/cjs/marketData.d.ts CHANGED Viewed

@@ -305,5 +305,5 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns a loyality score (4 worst, 1 best)
      */
     getTraderLoyalityScore(traderAddr: string, brokerAddr?: string): Promise<number>;
-    static _exchangeInfo(_proxyContract: ethers.Contract, _poolStaticInfos: Array<PoolStaticInfo>, _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _symbolList: Map<string, string>, _priceFeedGetter: PriceFeeds): Promise<ExchangeInfo>;
+    static _exchangeInfo(_proxyContract: ethers.Contract, _poolStaticInfos: Array<PoolStaticInfo>, _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _nestedPerpetualIDs: Array<Array<number>>, _symbolList: Map<string, string>, _priceFeedGetter: PriceFeeds): Promise<ExchangeInfo>;
 }

package/dist/cjs/marketData.js CHANGED Viewed

@@ -129,7 +129,7 @@ var MarketData = /** @class */ (function (_super) {
                         if (this.proxyContract == null) {
                             throw Error("no proxy contract initialized. Use createProxyInstance().");
                         }
-                        return [4 /*yield*/, MarketData._exchangeInfo(this.proxyContract, this.poolStaticInfos, this.symbolToPerpStaticInfo, this.symbolList, this.priceFeedGetter)];
+                        return [4 /*yield*/, MarketData._exchangeInfo(this.proxyContract, this.poolStaticInfos, this.symbolToPerpStaticInfo, this.nestedPerpetualIDs, this.symbolList, this.priceFeedGetter)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -692,6 +692,7 @@ var MarketData = /** @class */ (function (_super) {
         // return new copy, not a reference
         var res = {
             id: perpInfo.id,
+            poolId: perpInfo.poolId,
             limitOrderBookAddr: perpInfo.limitOrderBookAddr,
             initialMarginRate: perpInfo.initialMarginRate,
             maintenanceMarginRate: perpInfo.maintenanceMarginRate,
@@ -872,20 +873,17 @@ var MarketData = /** @class */ (function (_super) {
             });
         });
     };
-    MarketData._exchangeInfo = function (_proxyContract, _poolStaticInfos, _symbolToPerpStaticInfo, _symbolList, _priceFeedGetter) {
+    MarketData._exchangeInfo = function (_proxyContract, _poolStaticInfos, _symbolToPerpStaticInfo, _nestedPerpetualIDs, _symbolList, _priceFeedGetter) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var nestedPerpetualIDs, factory, info, numPools, allSym, _a, _b, perpSymbol, sInfo, allSymArr, idxPriceMap, j, perpetualIDs, pool, PoolState, k, perp, symS2, symS3, res, _c, indexS2, isS2MktClosed, indexS3, isS3MktClosed, fMidPrice, markPremiumRate, currentFundingRateBps, state, isMktClosed, PerpetualState;
+            var factory, info, numPools, allSym, _a, _b, perpSymbol, sInfo, allSymArr, idxPriceMap, j, perpetualIDs, pool, PoolState, k, perp, symS2, symS3, res, _c, indexS2, isS2MktClosed, indexS3, isS3MktClosed, fMidPrice, markPremiumRate, currentFundingRateBps, state, isMktClosed, PerpetualState;
             var e_1, _d;
             return tslib_1.__generator(this, function (_e) {
                 switch (_e.label) {
-                    case 0: return [4 /*yield*/, perpetualDataHandler_1.default.getNestedPerpetualIds(_proxyContract)];
+                    case 0: return [4 /*yield*/, _proxyContract.getOracleFactory()];
                     case 1:
-                        nestedPerpetualIDs = _e.sent();
-                        return [4 /*yield*/, _proxyContract.getOracleFactory()];
-                    case 2:
                         factory = _e.sent();
                         info = { pools: [], oracleFactoryAddr: factory, proxyAddr: _proxyContract.address };
-                        numPools = nestedPerpetualIDs.length;
+                        numPools = _nestedPerpetualIDs.length;
                         allSym = new Set();
                         try {
                             for (_a = tslib_1.__values(_symbolToPerpStaticInfo.keys()), _b = _a.next(); !_b.done; _b = _a.next()) {
@@ -906,15 +904,15 @@ var MarketData = /** @class */ (function (_super) {
                         }
                         allSymArr = Array.from(allSym.values());
                         return [4 /*yield*/, _priceFeedGetter.fetchPrices(allSymArr)];
-                    case 3:
+                    case 2:
                         idxPriceMap = _e.sent();
                         j = 0;
-                        _e.label = 4;
-                    case 4:
-                        if (!(j < numPools)) return [3 /*break*/, 12];
-                        perpetualIDs = nestedPerpetualIDs[j];
+                        _e.label = 3;
+                    case 3:
+                        if (!(j < numPools)) return [3 /*break*/, 11];
+                        perpetualIDs = _nestedPerpetualIDs[j];
                         return [4 /*yield*/, _proxyContract.getLiquidityPool(j + 1)];
-                    case 5:
+                    case 4:
                         pool = _e.sent();
                         PoolState = {
                             isRunning: pool.isRunning,
@@ -929,11 +927,11 @@ var MarketData = /** @class */ (function (_super) {
                             perpetuals: [],
                         };
                         k = 0;
-                        _e.label = 6;
-                    case 6:
-                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 10];
+                        _e.label = 5;
+                    case 5:
+                        if (!(k < perpetualIDs.length)) return [3 /*break*/, 9];
                         return [4 /*yield*/, _proxyContract.getPerpetual(perpetualIDs[k])];
-                    case 7:
+                    case 6:
                         perp = _e.sent();
                         symS2 = (0, utils_1.contractSymbolToSymbol)(perp.S2BaseCCY, _symbolList) +
                             "-" +
@@ -965,7 +963,7 @@ var MarketData = /** @class */ (function (_super) {
                                 (0, d8XMath_1.floatToABK64x64)(indexS2),
                                 (0, d8XMath_1.floatToABK64x64)(indexS3),
                             ])];
-                    case 8:
+                    case 7:
                         fMidPrice = _e.sent();
                         markPremiumRate = (0, d8XMath_1.ABK64x64ToFloat)(perp.currentMarkPremiumRate.fPrice);
                         currentFundingRateBps = 1e4 * (0, d8XMath_1.ABK64x64ToFloat)(perp.fCurrentFundingRate);
@@ -988,17 +986,17 @@ var MarketData = /** @class */ (function (_super) {
                             isMarketClosed: isMktClosed,
                         };
                         PoolState.perpetuals.push(PerpetualState);
-                        _e.label = 9;
-                    case 9:
+                        _e.label = 8;
+                    case 8:
                         k++;
-                        return [3 /*break*/, 6];
-                    case 10:
+                        return [3 /*break*/, 5];
+                    case 9:
                         info.pools.push(PoolState);
-                        _e.label = 11;
-                    case 11:
+                        _e.label = 10;
+                    case 10:
                         j++;
-                        return [3 /*break*/, 4];
-                    case 12: return [2 /*return*/, info];
+                        return [3 /*break*/, 3];
+                    case 11: return [2 /*return*/, info];
                 }
             });
         });