zklighter-perps 1.0.350 → 1.0.351

package/models/AccountLimits.ts

@@ -73,6 +73,12 @@ export interface AccountLimits {
      * @memberof AccountLimits
      */
     bo_fee_rate: number;
+    /**
+     *  Maker side multiplier; negative means the maker is rebated that share of the market maker fee.
+     * @type {number}
+     * @memberof AccountLimits
+     */
+    bo_maker_fee_rate: number;
     /**
      * 
      * @type {number}
@@ -135,6 +141,7 @@ export function instanceOfAccountLimits(value: object): value is AccountLimits {
     if (!('user_tier_name' in value) || value['user_tier_name'] === undefined) return false;
     if (!('bo_user_tier_name' in value) || value['bo_user_tier_name'] === undefined) return false;
     if (!('bo_fee_rate' in value) || value['bo_fee_rate'] === undefined) return false;
+    if (!('bo_maker_fee_rate' in value) || value['bo_maker_fee_rate'] === undefined) return false;
     if (!('current_maker_fee_tick' in value) || value['current_maker_fee_tick'] === undefined) return false;
     if (!('current_taker_fee_tick' in value) || value['current_taker_fee_tick'] === undefined) return false;
     if (!('leased_lit' in value) || value['leased_lit'] === undefined) return false;
@@ -164,6 +171,7 @@ export function AccountLimitsFromJSONTyped(json: any, ignoreDiscriminator: boole
         'user_tier_name': json['user_tier_name'],
         'bo_user_tier_name': json['bo_user_tier_name'],
         'bo_fee_rate': json['bo_fee_rate'],
+        'bo_maker_fee_rate': json['bo_maker_fee_rate'],
         'current_maker_fee_tick': json['current_maker_fee_tick'],
         'current_taker_fee_tick': json['current_taker_fee_tick'],
         'leased_lit': json['leased_lit'],
@@ -190,6 +198,7 @@ export function AccountLimitsToJSON(value?: AccountLimits | null): any {
         'user_tier_name': value['user_tier_name'],
         'bo_user_tier_name': value['bo_user_tier_name'],
         'bo_fee_rate': value['bo_fee_rate'],
+        'bo_maker_fee_rate': value['bo_maker_fee_rate'],
         'current_maker_fee_tick': value['current_maker_fee_tick'],
         'current_taker_fee_tick': value['current_taker_fee_tick'],
         'leased_lit': value['leased_lit'],

package/models/BOSizeCost.ts

@@ -49,37 +49,37 @@ export interface BOSizeCost {
      * @type {number}
      * @memberof BOSizeCost
      */
-    fill_rate: number;
+    fill_rate: number | null;
     /**
-     * 
+     *  mean over the samples; null unless status is ok
      * @type {BOSideCost}
      * @memberof BOSizeCost
      */
-    up: BOSideCost;
+    up: BOSideCost | null;
     /**
      * 
      * @type {BOSideCost}
      * @memberof BOSizeCost
      */
-    down: BOSideCost;
+    down: BOSideCost | null;
     /**
      *  cents per share, Up and Down averaged
      * @type {number}
      * @memberof BOSizeCost
      */
-    total_c: number;
+    total_c: number | null;
     /**
      *  % of the price paid, Up and Down averaged
      * @type {number}
      * @memberof BOSizeCost
      */
-    total_pct: number;
+    total_pct: number | null;
     /**
      *  size_usd * total_pct / 100
      * @type {number}
      * @memberof BOSizeCost
      */
-    cost_usd: number;
+    cost_usd: number | null;
 }
 
 /**

package/models/EventOrderBookEntry.ts

@@ -188,6 +188,12 @@ export interface EventOrderBookEntry {
      * @memberof EventOrderBookEntry
      */
     operator_account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof EventOrderBookEntry
+     */
+    fee_collector_account_index: number;
     /**
      * 
      * @type {number}
@@ -318,6 +324,7 @@ export function instanceOfEventOrderBookEntry(value: object): value is EventOrde
     if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
+    if (!('fee_collector_account_index' in value) || value['fee_collector_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
     if (!('settlement_type' in value) || value['settlement_type'] === undefined) return false;
     if (!('settlement_price' in value) || value['settlement_price'] === undefined) return false;
@@ -367,6 +374,7 @@ export function EventOrderBookEntryFromJSONTyped(json: any, ignoreDiscriminator:
         'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
+        'fee_collector_account_index': json['fee_collector_account_index'],
         'settlement_cap': json['settlement_cap'],
         'settlement_type': json['settlement_type'],
         'settlement_price': json['settlement_price'],
@@ -412,6 +420,7 @@ export function EventOrderBookEntryToJSON(value?: EventOrderBookEntry | null): a
         'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
+        'fee_collector_account_index': value['fee_collector_account_index'],
         'settlement_cap': value['settlement_cap'],
         'settlement_type': value['settlement_type'],
         'settlement_price': value['settlement_price'],

package/models/GuildLeaderboardEntry.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GuildDuelRecord } from './GuildDuelRecord';
+import {
+    GuildDuelRecordFromJSON,
+    GuildDuelRecordFromJSONTyped,
+    GuildDuelRecordToJSON,
+} from './GuildDuelRecord';
+
 /**
  * 
  * @export
@@ -67,6 +74,24 @@ export interface GuildLeaderboardEntry {
      * @memberof GuildLeaderboardEntry
      */
     volume: number;
+    /**
+     *  gross open perp notional of all members at mark price
+     * @type {number}
+     * @memberof GuildLeaderboardEntry
+     */
+    open_exposure: number;
+    /**
+     *  share of open_exposure that is long; absent without open positions
+     * @type {number}
+     * @memberof GuildLeaderboardEntry
+     */
+    long_percentage: number;
+    /**
+     * 
+     * @type {GuildDuelRecord}
+     * @memberof GuildLeaderboardEntry
+     */
+    duel_record: GuildDuelRecord;
 }
 
 /**
@@ -81,6 +106,9 @@ export function instanceOfGuildLeaderboardEntry(value: object): value is GuildLe
     if (!('ranked_member_count' in value) || value['ranked_member_count'] === undefined) return false;
     if (!('pnl' in value) || value['pnl'] === undefined) return false;
     if (!('volume' in value) || value['volume'] === undefined) return false;
+    if (!('open_exposure' in value) || value['open_exposure'] === undefined) return false;
+    if (!('long_percentage' in value) || value['long_percentage'] === undefined) return false;
+    if (!('duel_record' in value) || value['duel_record'] === undefined) return false;
     return true;
 }
 
@@ -102,6 +130,9 @@ export function GuildLeaderboardEntryFromJSONTyped(json: any, ignoreDiscriminato
         'ranked_member_count': json['ranked_member_count'],
         'pnl': json['pnl'],
         'volume': json['volume'],
+        'open_exposure': json['open_exposure'],
+        'long_percentage': json['long_percentage'],
+        'duel_record': GuildDuelRecordFromJSON(json['duel_record']),
     };
 }
 
@@ -119,6 +150,9 @@ export function GuildLeaderboardEntryToJSON(value?: GuildLeaderboardEntry | null
         'ranked_member_count': value['ranked_member_count'],
         'pnl': value['pnl'],
         'volume': value['volume'],
+        'open_exposure': value['open_exposure'],
+        'long_percentage': value['long_percentage'],
+        'duel_record': GuildDuelRecordToJSON(value['duel_record']),
     };
 }
 

package/models/GuildPnlStats.ts

@@ -49,6 +49,18 @@ export interface GuildPnlStats {
      * @memberof GuildPnlStats
      */
     ranked_member_count: number;
+    /**
+     *  gross open perp notional of all members at mark price
+     * @type {number}
+     * @memberof GuildPnlStats
+     */
+    open_exposure: number;
+    /**
+     *  share of open_exposure that is long; absent without open positions
+     * @type {number}
+     * @memberof GuildPnlStats
+     */
+    long_percentage: number;
     /**
      * 
      * @type {number}
@@ -66,6 +78,8 @@ export function instanceOfGuildPnlStats(value: object): value is GuildPnlStats {
     if (!('volume' in value) || value['volume'] === undefined) return false;
     if (!('rank' in value) || value['rank'] === undefined) return false;
     if (!('ranked_member_count' in value) || value['ranked_member_count'] === undefined) return false;
+    if (!('open_exposure' in value) || value['open_exposure'] === undefined) return false;
+    if (!('long_percentage' in value) || value['long_percentage'] === undefined) return false;
     if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
     return true;
 }
@@ -85,6 +99,8 @@ export function GuildPnlStatsFromJSONTyped(json: any, ignoreDiscriminator: boole
         'volume': json['volume'],
         'rank': json['rank'],
         'ranked_member_count': json['ranked_member_count'],
+        'open_exposure': json['open_exposure'],
+        'long_percentage': json['long_percentage'],
         'updated_at': json['updated_at'],
     };
 }
@@ -100,6 +116,8 @@ export function GuildPnlStatsToJSON(value?: GuildPnlStats | null): any {
         'volume': value['volume'],
         'rank': value['rank'],
         'ranked_member_count': value['ranked_member_count'],
+        'open_exposure': value['open_exposure'],
+        'long_percentage': value['long_percentage'],
         'updated_at': value['updated_at'],
     };
 }

package/models/OrderBook.ts

@@ -181,6 +181,12 @@ export interface OrderBook {
      * @memberof OrderBook
      */
     operator_account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderBook
+     */
+    fee_collector_account_index: number;
     /**
      * 
      * @type {number}
@@ -293,6 +299,7 @@ export function instanceOfOrderBook(value: object): value is OrderBook {
     if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
+    if (!('fee_collector_account_index' in value) || value['fee_collector_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
     if (!('settlement_type' in value) || value['settlement_type'] === undefined) return false;
     if (!('settlement_price' in value) || value['settlement_price'] === undefined) return false;
@@ -339,6 +346,7 @@ export function OrderBookFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
+        'fee_collector_account_index': json['fee_collector_account_index'],
         'settlement_cap': json['settlement_cap'],
         'settlement_type': json['settlement_type'],
         'settlement_price': json['settlement_price'],
@@ -381,6 +389,7 @@ export function OrderBookToJSON(value?: OrderBook | null): any {
         'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
+        'fee_collector_account_index': value['fee_collector_account_index'],
         'settlement_cap': value['settlement_cap'],
         'settlement_type': value['settlement_type'],
         'settlement_price': value['settlement_price'],

package/models/PerpsOrderBookDetail.ts

@@ -188,6 +188,12 @@ export interface PerpsOrderBookDetail {
      * @memberof PerpsOrderBookDetail
      */
     operator_account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerpsOrderBookDetail
+     */
+    fee_collector_account_index: number;
     /**
      * 
      * @type {number}
@@ -444,6 +450,7 @@ export function instanceOfPerpsOrderBookDetail(value: object): value is PerpsOrd
     if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
+    if (!('fee_collector_account_index' in value) || value['fee_collector_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
     if (!('settlement_type' in value) || value['settlement_type'] === undefined) return false;
     if (!('settlement_price' in value) || value['settlement_price'] === undefined) return false;
@@ -514,6 +521,7 @@ export function PerpsOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator
         'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
+        'fee_collector_account_index': json['fee_collector_account_index'],
         'settlement_cap': json['settlement_cap'],
         'settlement_type': json['settlement_type'],
         'settlement_price': json['settlement_price'],
@@ -580,6 +588,7 @@ export function PerpsOrderBookDetailToJSON(value?: PerpsOrderBookDetail | null):
         'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
+        'fee_collector_account_index': value['fee_collector_account_index'],
         'settlement_cap': value['settlement_cap'],
         'settlement_type': value['settlement_type'],
         'settlement_price': value['settlement_price'],

package/models/PublicProfile.ts

@@ -49,6 +49,18 @@ export interface PublicProfile {
      * @memberof PublicProfile
      */
     x_handle?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicProfile
+     */
+    guild_id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicProfile
+     */
+    guild_name: string;
 }
 
 
@@ -69,6 +81,8 @@ export type PublicProfileDisplayNameSourceEnum = typeof PublicProfileDisplayName
  */
 export function instanceOfPublicProfile(value: object): value is PublicProfile {
     if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('guild_id' in value) || value['guild_id'] === undefined) return false;
+    if (!('guild_name' in value) || value['guild_name'] === undefined) return false;
     return true;
 }
 
@@ -87,6 +101,8 @@ export function PublicProfileFromJSONTyped(json: any, ignoreDiscriminator: boole
         'display_name_source': json['display_name_source'] == null ? undefined : json['display_name_source'],
         'x_user_id': json['x_user_id'] == null ? undefined : json['x_user_id'],
         'x_handle': json['x_handle'] == null ? undefined : json['x_handle'],
+        'guild_id': json['guild_id'],
+        'guild_name': json['guild_name'],
     };
 }
 
@@ -101,6 +117,8 @@ export function PublicProfileToJSON(value?: PublicProfile | null): any {
         'display_name_source': value['display_name_source'],
         'x_user_id': value['x_user_id'],
         'x_handle': value['x_handle'],
+        'guild_id': value['guild_id'],
+        'guild_name': value['guild_name'],
     };
 }
 

package/models/RespGetGuild.ts

@@ -115,7 +115,7 @@ export interface RespGetGuild {
      * @type {GuildPnlStats}
      * @memberof RespGetGuild
      */
-    stats?: GuildPnlStats;
+    stats?: GuildPnlStats | null;
     /**
      * 
      * @type {Array<GuildPosition>}

package/models/SpotOrderBookDetail.ts

@@ -181,6 +181,12 @@ export interface SpotOrderBookDetail {
      * @memberof SpotOrderBookDetail
      */
     operator_account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SpotOrderBookDetail
+     */
+    fee_collector_account_index: number;
     /**
      * 
      * @type {number}
@@ -353,6 +359,7 @@ export function instanceOfSpotOrderBookDetail(value: object): value is SpotOrder
     if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
+    if (!('fee_collector_account_index' in value) || value['fee_collector_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
     if (!('settlement_type' in value) || value['settlement_type'] === undefined) return false;
     if (!('settlement_price' in value) || value['settlement_price'] === undefined) return false;
@@ -409,6 +416,7 @@ export function SpotOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator:
         'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
+        'fee_collector_account_index': json['fee_collector_account_index'],
         'settlement_cap': json['settlement_cap'],
         'settlement_type': json['settlement_type'],
         'settlement_price': json['settlement_price'],
@@ -461,6 +469,7 @@ export function SpotOrderBookDetailToJSON(value?: SpotOrderBookDetail | null): a
         'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
+        'fee_collector_account_index': value['fee_collector_account_index'],
         'settlement_cap': value['settlement_cap'],
         'settlement_type': value['settlement_type'],
         'settlement_price': value['settlement_price'],

package/openapi.json

@@ -8626,6 +8626,12 @@
           "example": "0.72",
           "description": " Product of the staking and BO volume multipliers; 0.72 means a 28% discount."
         },
+        "bo_maker_fee_rate": {
+          "type": "number",
+          "format": "double",
+          "example": "0.72",
+          "description": " Maker side multiplier; negative means the maker is rebated that share of the market maker fee."
+        },
         "current_maker_fee_tick": {
           "type": "integer",
           "format": "int32",
@@ -8669,6 +8675,7 @@
         "user_tier_name",
         "bo_user_tier_name",
         "bo_fee_rate",
+        "bo_maker_fee_rate",
         "current_maker_fee_tick",
         "current_taker_fee_tick",
         "leased_lit",
@@ -10055,32 +10062,46 @@
           "type": "number",
           "format": "double",
           "example": "0.97",
-          "description": " share of the venue's in-band samples where the size filled; null without any"
+          "description": " share of the venue's in-band samples where the size filled; null without any",
+          "x-nullable": true
         },
         "up": {
-          "$ref": "#/definitions/BOSideCost",
-          "description": " mean over the samples; null unless status is ok"
+          "allOf": [
+            {
+              "$ref": "#/definitions/BOSideCost"
+            }
+          ],
+          "description": " mean over the samples; null unless status is ok",
+          "x-nullable": true
         },
         "down": {
-          "$ref": "#/definitions/BOSideCost"
+          "allOf": [
+            {
+              "$ref": "#/definitions/BOSideCost"
+            }
+          ],
+          "x-nullable": true
         },
         "total_c": {
           "type": "number",
           "format": "double",
           "example": "0.75",
-          "description": " cents per share, Up and Down averaged"
+          "description": " cents per share, Up and Down averaged",
+          "x-nullable": true
         },
         "total_pct": {
           "type": "number",
           "format": "double",
           "example": "1.47",
-          "description": " % of the price paid, Up and Down averaged"
+          "description": " % of the price paid, Up and Down averaged",
+          "x-nullable": true
         },
         "cost_usd": {
           "type": "number",
           "format": "double",
           "example": "1.47",
-          "description": " size_usd * total_pct / 100"
+          "description": " size_usd * total_pct / 100",
+          "x-nullable": true
         }
       },
       "title": "BOSizeCost",
@@ -11771,6 +11792,11 @@
           "format": "int64",
           "example": "1"
         },
+        "fee_collector_account_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
         "settlement_cap": {
           "type": "integer",
           "format": "int32",
@@ -11850,6 +11876,7 @@
         "open_interest_usd",
         "outcome",
         "operator_account_index",
+        "fee_collector_account_index",
         "settlement_cap",
         "settlement_type",
         "settlement_price",
@@ -13042,6 +13069,19 @@
         "volume": {
           "type": "number",
           "format": "double"
+        },
+        "open_exposure": {
+          "type": "number",
+          "format": "double",
+          "description": " gross open perp notional of all members at mark price"
+        },
+        "long_percentage": {
+          "type": "number",
+          "format": "double",
+          "description": " share of open_exposure that is long; absent without open positions"
+        },
+        "duel_record": {
+          "$ref": "#/definitions/GuildDuelRecord"
         }
       },
       "title": "GuildLeaderboardEntry",
@@ -13053,7 +13093,10 @@
         "member_count",
         "ranked_member_count",
         "pnl",
-        "volume"
+        "volume",
+        "open_exposure",
+        "long_percentage",
+        "duel_record"
       ]
     },
     "GuildListItem": {
@@ -13148,6 +13191,16 @@
           "type": "integer",
           "format": "int64"
         },
+        "open_exposure": {
+          "type": "number",
+          "format": "double",
+          "description": " gross open perp notional of all members at mark price"
+        },
+        "long_percentage": {
+          "type": "number",
+          "format": "double",
+          "description": " share of open_exposure that is long; absent without open positions"
+        },
         "updated_at": {
           "type": "integer",
           "format": "int64"
@@ -13160,6 +13213,8 @@
         "volume",
         "rank",
         "ranked_member_count",
+        "open_exposure",
+        "long_percentage",
         "updated_at"
       ]
     },
@@ -14458,6 +14513,11 @@
           "format": "int64",
           "example": "1"
         },
+        "fee_collector_account_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
         "settlement_cap": {
           "type": "integer",
           "format": "int32",
@@ -14524,6 +14584,7 @@
         "open_interest_usd",
         "outcome",
         "operator_account_index",
+        "fee_collector_account_index",
         "settlement_cap",
         "settlement_type",
         "settlement_price",
@@ -15361,6 +15422,11 @@
           "format": "int64",
           "example": "1"
         },
+        "fee_collector_account_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
         "settlement_cap": {
           "type": "integer",
           "format": "int32",
@@ -15541,6 +15607,7 @@
         "open_interest_usd",
         "outcome",
         "operator_account_index",
+        "fee_collector_account_index",
         "settlement_cap",
         "settlement_type",
         "settlement_price",
@@ -16495,11 +16562,20 @@
         "x_handle": {
           "type": "string",
           "description": " as of connecting"
+        },
+        "guild_id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "guild_name": {
+          "type": "string"
         }
       },
       "title": "PublicProfile",
       "required": [
-        "l1_address"
+        "l1_address",
+        "guild_id",
+        "guild_name"
       ]
     },
     "PushNotifDeliveryResult": {
@@ -21369,7 +21445,11 @@
           }
         },
         "stats": {
-          "$ref": "#/definitions/GuildPnlStats",
+          "allOf": [
+            {
+              "$ref": "#/definitions/GuildPnlStats"
+            }
+          ],
           "x-nullable": true
         },
         "positions": {
@@ -23332,6 +23412,11 @@
           "format": "int64",
           "example": "1"
         },
+        "fee_collector_account_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
         "settlement_cap": {
           "type": "integer",
           "format": "int32",
@@ -23451,6 +23536,7 @@
         "open_interest_usd",
         "outcome",
         "operator_account_index",
+        "fee_collector_account_index",
         "settlement_cap",
         "settlement_type",
         "settlement_price",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.350",
+  "version": "1.0.351",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {