@d8x/perpetuals-sdk 2.1.5-alpha2 → 2.1.7-alpha2

package/doc/perpetualDataHandler.md

@@ -9,6 +9,7 @@ common data and chain operations.</p>
 * [PerpetualDataHandler](#PerpetualDataHandler)
     * [new PerpetualDataHandler(config)](#new_PerpetualDataHandler_new)
     * _instance_
+        * [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList)
         * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
         * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
         * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
@@ -72,6 +73,12 @@ common data and chain operations.</p>
 | --- | --- | --- |
 | config | <code>NodeSDKConfig</code> | <p>Configuration object, see PerpetualDataHandler.readSDKConfig.</p> |
 
+<a name="PerpetualDataHandler+fetchSymbolList"></a>
+
+### perpetualDataHandler.fetchSymbolList()
+<p>sets the symbollist if a remote config url is specified</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
 <a name="PerpetualDataHandler+getOrderBookContract"></a>
 
 ### perpetualDataHandler.getOrderBookContract(symbol) ⇒

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d8x/perpetuals-sdk",
-  "version": "2.1.5-alpha2",
+  "version": "2.1.7-alpha2",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
   "author": "D8X",
   "homepage": "https://github.com/D8-X/d8x-futures-node-sdk#readme",

package/src/config/defaultConfig.json

@@ -93,7 +93,8 @@
     "shareTokenABILocation": "./abi/ShareToken.json",
     "proxyABILocation": "./abi/IPerpetualManager.json",
     "limitOrderBookFactoryABILocation": "./abi/LimitOrderBookFactory.json",
-    "limitOrderBookABILocation": "./abi/LimitOrderBook.json"
+    "limitOrderBookABILocation": "./abi/LimitOrderBook.json",
+    "configSource": "https://raw.githubusercontent.com/D8-X/sync-hub/main/d8x-futures-node-sdk/"
   },
   {
     "name": "artio",
@@ -118,7 +119,8 @@
     "shareTokenABILocation": "./abi/ShareToken.json",
     "proxyABILocation": "./abi/IPerpetualManager.json",
     "limitOrderBookFactoryABILocation": "./abi/LimitOrderBookFactory.json",
-    "limitOrderBookABILocation": "./abi/LimitOrderBook.json"
+    "limitOrderBookABILocation": "./abi/LimitOrderBook.json",
+    "configSource": "https://raw.githubusercontent.com/D8-X/sync-hub/main/d8x-futures-node-sdk/"
   },
   {
     "name": "xlayer",
@@ -130,7 +132,8 @@
     "shareTokenABILocation": "./abi/ShareToken.json",
     "proxyABILocation": "./abi/IPerpetualManager.json",
     "limitOrderBookFactoryABILocation": "./abi/LimitOrderBookFactory.json",
-    "limitOrderBookABILocation": "./abi/LimitOrderBook.json"
+    "limitOrderBookABILocation": "./abi/LimitOrderBook.json",
+    "configSource": "https://raw.githubusercontent.com/D8-X/sync-hub/main/d8x-futures-node-sdk/"
   },
   {
     "name": "bartio",
@@ -142,7 +145,8 @@
     "shareTokenABILocation": "./abi/ShareToken.json",
     "proxyABILocation": "./abi/IPerpetualManager.json",
     "limitOrderBookFactoryABILocation": "./abi/LimitOrderBookFactory.json",
-    "limitOrderBookABILocation": "./abi/LimitOrderBook.json"
+    "limitOrderBookABILocation": "./abi/LimitOrderBook.json",
+    "configSource": "https://raw.githubusercontent.com/D8-X/sync-hub/main/d8x-futures-node-sdk/"
   },
   {
     "name": "europaTestnet",

package/src/config/priceFeedConfig.json

@@ -2,6 +2,12 @@
   {
     "network": "mainnet",
     "ids": [
+      {
+        "symbol": "BTLJ-USD",
+        "id": "0xE40F3EF726A04AD63510BAF90238F6BCACF4365DB2A38E02A6E8623C2BEDC97D",
+        "type": "polymarket",
+        "origin": "0x3157ea263270be44bd68a3d6bde1f6f639be2746974f65de24e00ea6378d7838"
+      },
       {
         "symbol": "TRUMP24-USD",
         "id": "0x3011e4ede0f6befa0ad3f571001d3e1ffeef3d4af78c3112aaac90416e3a43e7",
@@ -166,6 +172,12 @@
   {
     "network": "odin",
     "ids": [
+      {
+        "symbol": "BTLJ-USD",
+        "id": "0xE40F3EF726A04AD63510BAF90238F6BCACF4365DB2A38E02A6E8623C2BEDC97D",
+        "type": "polymarket",
+        "origin": "0x3157ea263270be44bd68a3d6bde1f6f639be2746974f65de24e00ea6378d7838"
+      },
       {
         "symbol": "TRUMP24-USD",
         "id": "0x3011e4ede0f6befa0ad3f571001d3e1ffeef3d4af78c3112aaac90416e3a43e7",

package/src/config/symbolList.json

@@ -26,5 +26,6 @@
   "ETHf": "ETHFI",
   "ZK": "ZK",
   "PNDL": "PENDLE",
-  "TR24": "TRUMP24"
+  "TR24": "TRUMP24",
+  "BTLJ": "BTLJ"
 }

package/src/d8XMath.ts

@@ -664,7 +664,7 @@ function excessMargin(
  * @param price
  * @param S3
  * @param S2Mark
- * @returns
+ * @returns deposit amount
  */
 function pmGetDepositAmtForLvgTrade(
   tradeAmt: number,
@@ -703,7 +703,7 @@ function pmGetDepositAmtForLvgTrade(
  * @param S3
  * @param totLong
  * @param totShort
- * @returns
+ * @returns excess cash
  */
 function pmExcessCashAtLvg(
   tradeAmt: number,
@@ -776,7 +776,7 @@ function pmExcessCashAtLvg(
  * @param totShort
  * @param maxShort
  * @param maxLong
- * @returns
+ * @returns max trade size
  */
 export function pmFindMaxPersonalTradeSizeAtLeverage(
   dir: number,

package/src/marketData.ts

@@ -108,6 +108,7 @@ export default class MarketData extends PerpetualDataHandler {
    * @param providerOrMarketData optional provider or existing market data instance
    */
   public async createProxyInstance(providerOrMarketData?: Provider | MarketData, overrides?: Overrides): Promise<void> {
+    await this.priceFeedGetter.init();
     if (providerOrMarketData == undefined || !("createProxyInstance" in providerOrMarketData)) {
       this.provider = providerOrMarketData ?? new JsonRpcProvider(this.nodeURL);
       await this.initContractsAndData(this.provider, overrides);
@@ -2507,11 +2508,11 @@ export default class MarketData extends PerpetualDataHandler {
   }
 
   /**
-   * fetch prediction markets question
+   * fetch prediction markets meta data
    * @param symbol symbol of the form "TRUMP24-USD"
    * @returns question for given symbol
    */
-  public async fetchPrdMktQuestion(symbol: string): Promise<string> {
+  public async fetchPrdMktMetaData(symbol: string): Promise<string> {
     const c = this.priceFeedGetter.getConfig().ids;
     let j = -1;
     for (let k = 0; k < c.length; k++) {
@@ -2533,6 +2534,6 @@ export default class MarketData extends PerpetualDataHandler {
       throw new Error(`failed to fetch posts (${response.status}): ${response.statusText} ${query}`);
     }
     const data = await response.json();
-    return data.question;
+    return data;
   }
 }

package/src/nodeSDKTypes.ts

@@ -6,6 +6,7 @@ export interface NodeSDKConfig {
   chainId: number;
   version: number;
   nodeURL: string;
+  configSource: string;
   proxyAddr: string;
   proxyABILocation: string;
   shareTokenABILocation: string;

package/src/perpetualDataHandler.ts

@@ -166,6 +166,7 @@ export default class PerpetualDataHandler {
   }
 
   protected async initContractsAndData(signerOrProvider: Signer | Provider, overrides?: Overrides) {
+    await this.fetchSymbolList();
     this.signerOrProvider = signerOrProvider;
     // check network
     let network: Network;
@@ -187,6 +188,24 @@ export default class PerpetualDataHandler {
     await this._fillSymbolMaps(overrides);
   }
 
+  /**
+   * sets the symbollist if a remote config url is specified
+   */
+  private async fetchSymbolList() {
+    if (this.config.configSource == "" || this.config.configSource == undefined) {
+      return;
+    }
+    const res = await fetch(this.config.configSource + "/symbolList.json");
+    if (res.status !== 200) {
+      throw new Error(`failed to fetch symbolList status code: ${res.status}`);
+    }
+    if (!res.ok) {
+      throw new Error(`failed to fetch config (${res.status}): ${res.statusText} ${this.config.configSource}`);
+    }
+    let symlist = await res.json();
+    this.symbolList = new Map<string, string>(Object.entries(symlist));
+  }
+
   /**
    * Returns the order-book contract for the symbol if found or fails
    * @param symbol symbol of the form ETH-USD-MATIC

package/src/priceFeeds.ts

@@ -22,10 +22,11 @@ import { sleep } from "./utils";
  * trader liquidations, trade executions, change of trader margin amount.
  */
 export default class PriceFeeds {
-  private config: PriceFeedConfig;
+  private config: PriceFeedConfig | undefined;
+  private priceFeedConfigNetwork: string;
   // Read only price info endpoints. Used by default. feedEndpoints[endpointId]
   // = endpointstring
-  public feedEndpoints: Array<string>;
+  public feedEndpoints: Array<string> = [];
   // Endpoints which are used to fetch prices for submissions
   public writeFeedEndpoints: Array<string> = [];
   private feedInfo: Map<string, { symbol: string; endpointId: number }[]>; // priceFeedId -> [symbol, endpointId]
@@ -38,22 +39,47 @@ export default class PriceFeeds {
   // api formatting constants
   private PYTH = { endpoint: "/v2/updates/price/latest?encoding=base64&ids[]=", separator: "&ids[]=", suffix: "" };
 
-  private polyMktsPxFeed: PolyMktsPxFeed;
+  private polyMktsPxFeed: PolyMktsPxFeed | undefined;
 
   constructor(dataHandler: PerpetualDataHandler, priceFeedConfigNetwork: string) {
-    let configs = require("./config/priceFeedConfig.json") as PriceFeedConfig[];
-    this.config = PriceFeeds._selectConfig(configs, priceFeedConfigNetwork);
+    this.priceFeedConfigNetwork = priceFeedConfigNetwork;
+    this.onChainPxFeeds = new Map<string, OnChainPxFeed>();
+    this.dataHandler = dataHandler;
+    this.triangulations = new Map<string, [string[], boolean[]]>();
+    this.feedInfo = new Map<string, { symbol: string; endpointId: number }[]>();
+  }
+
+  /**
+   * initialization function. Gathers config from config-hub if url
+   * specified
+   */
+  public async init() {
+    let configs: PriceFeedConfig[];
+    const configSrc = this.dataHandler.config.configSource;
+    if (configSrc == "" || configSrc == undefined) {
+      // embedded config
+      configs = require("./config/priceFeedConfig.json") as PriceFeedConfig[];
+    } else {
+      //load remote config
+      const res = await fetch(configSrc + "/priceFeedConfig.json");
+      if (res.status !== 200) {
+        throw new Error(`failed to fetch priceFeedConfig status code: ${res.status}`);
+      }
+      if (!res.ok) {
+        throw new Error(`failed to fetch config (${res.status}): ${res.statusText} ${configSrc}`);
+      }
+      configs = await res.json();
+    }
+    this.config = PriceFeeds._selectConfig(configs, this.priceFeedConfigNetwork);
 
     // if SDK config contains custom price feed endpoints, these override the
     // public/default ones
-    if (dataHandler.config.priceFeedEndpoints && dataHandler.config.priceFeedEndpoints.length > 0) {
+    if (this.dataHandler.config.priceFeedEndpoints && this.dataHandler.config.priceFeedEndpoints.length > 0) {
       this.config.endpoints = PriceFeeds.overridePriceEndpointsOfSameType(
         this.config.endpoints,
-        dataHandler.config.priceFeedEndpoints
+        this.dataHandler.config.priceFeedEndpoints
       );
     }
-
-    this.onChainPxFeeds = new Map<string, OnChainPxFeed>();
     for (let k = 0; k < this.config.ids.length; k++) {
       if (this.config.ids[k].type == "onchain") {
         let sym = this.config.ids[k].symbol;
@@ -69,11 +95,12 @@ export default class PriceFeeds {
       throw new Error("PriceFeeds: no writeEndpoints provided in config");
     }
     this.polyMktsPxFeed = new PolyMktsPxFeed(this.config);
-    this.dataHandler = dataHandler;
-    this.triangulations = new Map<string, [string[], boolean[]]>();
   }
 
   public getConfig(): PriceFeedConfig {
+    if (this.config == undefined) {
+      throw Error("init() required");
+    }
     return this.config;
   }
   // overridePriceEndpointsOfSameType overrides endpoints of config with same
@@ -209,6 +236,9 @@ export default class PriceFeeds {
    * ema, confidence, and order book parameters.
    */
   public async fetchPricesForPerpetual(symbol: string): Promise<IdxPriceInfo> {
+    if (this.polyMktsPxFeed == undefined) {
+      throw Error("init() required");
+    }
     let indexSymbols = this.dataHandler.getIndexSymbols(symbol).filter((x) => x != "");
     if (this.dataHandler.isPredictionMarket(symbol)) {
       let priceObj = await this.polyMktsPxFeed.fetchPriceForSym(indexSymbols[0]);
@@ -265,6 +295,9 @@ export default class PriceFeeds {
    * <symbol>:ema for each polymarket symbol that maps to the ema price
    */
   public async fetchFeedPrices(symbols?: string[]): Promise<Map<string, [number, boolean]>> {
+    if (this.config == undefined) {
+      throw Error("init() required");
+    }
     let queries = new Array<string>(this.feedEndpoints.length);
     let suffixes = new Array<string>(queries.length);
     let symbolsOfEndpoint: string[][] = [];
@@ -347,6 +380,9 @@ export default class PriceFeeds {
 
   // returns an array with two values per symbol: price, ema
   private async queryPolyMktsPxFeeds(symbols: string[]) {
+    if (this.polyMktsPxFeed == undefined) {
+      throw Error("init() required");
+    }
     let prices = new Array<PredMktPriceInfo | undefined>();
     for (let k = 0; k < symbols.length; k++) {
       try {
@@ -380,6 +416,9 @@ export default class PriceFeeds {
    * contract and corresponding price information
    */
   public async fetchLatestFeedPriceInfoForPerpetual(symbol: string): Promise<PriceFeedSubmission> {
+    if (this.config == undefined) {
+      throw Error("init() required");
+    }
     // get the feedIds that the contract uses
     let feedIds = this.dataHandler.getPriceIds(symbol);
     let queries = new Array<string>();

package/src/version.ts

@@ -1 +1 @@
-export const D8X_SDK_VERSION = "2.1.5-alpha2";
+export const D8X_SDK_VERSION = "2.1.7-alpha2";

package/src/writeAccessHandler.ts

@@ -55,6 +55,7 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
    * @param provider optional provider
    */
   public async createProxyInstance(providerOrMarketData?: Provider | MarketData, overrides?: Overrides) {
+    await this.priceFeedGetter.init();
     if (providerOrMarketData == undefined || !("createProxyInstance" in providerOrMarketData)) {
       this.provider = providerOrMarketData ?? new JsonRpcProvider(this.nodeURL, this.network, { staticNetwork: true });
       if (!this.signer) {

package/dist/cjs/abi/BeaconProxy.json

@@ -1,71 +0,0 @@
-[
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "beacon",
-                "type": "address"
-            },
-            {
-                "internalType": "bytes",
-                "name": "data",
-                "type": "bytes"
-            }
-        ],
-        "stateMutability": "payable",
-        "type": "constructor"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": false,
-                "internalType": "address",
-                "name": "previousAdmin",
-                "type": "address"
-            },
-            {
-                "indexed": false,
-                "internalType": "address",
-                "name": "newAdmin",
-                "type": "address"
-            }
-        ],
-        "name": "AdminChanged",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "beacon",
-                "type": "address"
-            }
-        ],
-        "name": "BeaconUpgraded",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "implementation",
-                "type": "address"
-            }
-        ],
-        "name": "Upgraded",
-        "type": "event"
-    },
-    {
-        "stateMutability": "payable",
-        "type": "fallback"
-    },
-    {
-        "stateMutability": "payable",
-        "type": "receive"
-    }
-]