zklighter-perps 1.0.302 → 1.0.304

package/.openapi-generator/FILES

@@ -259,6 +259,8 @@ models/Status.ts
 models/StockBalanceSheet.ts
 models/StockCashFlowStatement.ts
 models/StockFinancial.ts
+models/StockFinancialDividendEvent.ts
+models/StockFinancialDividends.ts
 models/StockFinancialEarnings.ts
 models/StockFinancialEarningsEvent.ts
 models/StockFinancialHistoricalEarning.ts

package/README.md

@@ -1,86 +1,50 @@
-# zklighter-perps-ts
+# zklighter-perps
 
-Auto-generated TypeScript SDK for the Lighter Perps API, published to npm as
+TypeScript client for the Lighter Perps REST API, published to npm as
 [`zklighter-perps`](https://www.npmjs.com/package/zklighter-perps).
 
-The SDK source (`index.ts`, `runtime.ts`, `apis/`, `models/`) is **generated** by
-the [OpenAPI Generator](https://openapi-generator.tech) from the backend's
-OpenAPI spec. Do not edit the generated files by hand — they are overwritten on
-every regeneration. The package ships raw `.ts` (`"main": "index.ts"`), so
-consumers compile it themselves.
+The client is generated from the backend's OpenAPI spec with
+[OpenAPI Generator](https://openapi-generator.tech) (`typescript-fetch`). It
+ships raw `.ts` (`"main": "index.ts"`), so your bundler or `tsc` compiles it
+along with your own code.
 
-## Generation pipeline (CircleCI)
+## Install
 
-Defined in [`.circleci/config.yml`](.circleci/config.yml). The `update_ts_sdk`
-workflow (manually triggered) runs three jobs in sequence:
-
-1. **`update_openapi`** — clones `zklighter-perps`, runs `goctl-swagger` to emit
-   the raw `openapi.json`, and persists it. This job no longer transforms the
-   spec; it only generates and persists it.
-2. **`openapi_postprocess`** — runs
-   [`.circleci/openapi_postprocess.py`](.circleci/openapi_postprocess.py), the
-   **single source of truth** for all spec fixups (see below).
-3. **`update_ts_sdk`** — runs the OpenAPI Generator on the post-processed spec,
-   bumps the package version, and opens a PR.
-
-The `update_npm_package` workflow runs on `main`:
+```bash
+npm install zklighter-perps
+```
 
-- **`typecheck`** — `npm install && npm run typecheck` (`tsc --noEmit` using
-  [`tsconfig.json`](tsconfig.json)). Runs on every branch, including the
-  timestamped branches opened by `update_ts_sdk`, so a regenerated SDK that
-  would fail to compile in a consumer (e.g. `perps-fe`) is caught on its PR.
-- **`update_npm_package`** — publishes to npm (requires `typecheck` to pass;
-  `main` only).
-- **`publish_prerelease`** — on non-`main` branches with an open PR, publishes
-  a prerelease version (`0.<PR>.0-<actor>.<sha>.<branch>`, npm dist-tag =
-  branch name) and posts/updates a PR comment with the exact version to drop
-  into a consumer's `package.json`, mirroring the prerelease flow in
-  `zklighter-react-store`.
+## Usage
 
-## OpenAPI post-processing
+```ts
+import { Configuration, OrderApi } from 'zklighter-perps'
 
-The spec emitted by `goctl-swagger` has quirks that either break the OpenAPI
-Generator or produce an awkward SDK, so we post-process it before generation.
-All of this lives in **one place** — `.circleci/openapi_postprocess.py`.
-(Historically some of these fixes were inline `jq`/`sed` commands in the
-`update_openapi` job; they have been consolidated into the script so the logic
-is in a single, testable file.)
+const orderApi = new OrderApi(
+  new Configuration({ basePath: 'https://mainnet.zklighter.elliot.ai' }),
+)
 
-Why each transform exists:
+const orderBooks = await orderApi.orderBooks()
+```
 
-1. **Drop internal endpoints/definitions** (`/api/v1/feedback`,
-   `/api/v1/ws_status`, `/stream`, `/api/v1/permission`, `ReqSendFeedback`) —
-   not part of the public SDK surface.
-2. **Strip empty-string keys** — the generator emits `""` keys the OpenAPI
-   Generator cannot process.
-3. **Mirror `summary` into `description`** — preserves the original
-   human-readable text as the generated doc comment before `summary` is
-   overwritten in step 8.
-4. **Seed `summary` from `operationId`** — normalizes naming before step 8.
-5. **Add a documented `400` response** referencing `ResultCode` to every
-   operation, so the SDK models the standard error shape.
-6. **Model the `types` parameter as a byte array** (`array` of `uint8`) instead
-   of the non-standard scalar the spec declares.
-7. **Remove placeholder `"-"` enum/array values** that aren't real values.
-8. **Derive stable, path-based `operationId`/`summary`** (e.g.
-   `/api/v1/account` → `account`) so generated method names are predictable.
-9. **Inline non-standard `int16`/`float64`/map `$ref`s** (`int16`, `float64`,
-   `mapint16string`, `mapstringfloat64`) — these are not standard OpenAPI and
-   make the generator emit broken model references.
-10. **Move array-level `enum` into `items`** — correct placement for array
-    schemas.
-11. **Make the `transfer/history` `type` param an array** of enum strings.
-12. **Trim over-eager `required` fields** — the backend marks fields required
-    that are actually optional in responses; we relax them so deserialization
-    doesn't reject valid payloads.
+Every API group has a class in [`apis/`](apis) (`AccountApi`, `OrderApi`,
+`TransactionApi`, ...) and every request/response type lives in
+[`models/`](models). `basePath` defaults to mainnet; pass the testnet URL to
+target testnet. Endpoints that need authentication take an `auth` parameter.
 
-## Local development
+## Development
 
 ```bash
-npm install        # installs TypeScript (the only dependency)
-npm run typecheck  # same check CI runs: tsc --noEmit
+npm install         # also wires the git hooks (.githooks)
+npm run typecheck   # tsc --noEmit, the same check CI runs
+npm run scan:secrets
 ```
 
-To test the post-processing script against a spec locally, place an
-`openapi.json` next to the script and run `python3 openapi_postprocess.py`
-(it reads/writes `./openapi.json`).
+`index.ts`, `runtime.ts`, `apis/` and `models/` are generated. Do not edit
+them by hand; they are overwritten on the next regeneration. Regeneration,
+spec post-processing and npm publishing all run in CircleCI and are documented
+in [`.circleci/README.md`](.circleci/README.md).
+
+A pre-commit hook scans staged files for secrets, and `npm publish` runs the
+same scan over the whole package before uploading. Both use
+[secretlint](https://github.com/secretlint/secretlint) with the recommended
+preset; exclusions go in `.secretlintignore`.

package/apis/StockfinancialsApi.ts

@@ -36,7 +36,7 @@ export interface StockFinancialsRequest {
 export class StockfinancialsApi extends runtime.BaseAPI {
 
     /**
-     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id.
+     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings, next_dividend; omit it to get the full record, which requires market_id.
      * stockFinancials
      */
     async stockFinancialsRaw(requestParameters: StockFinancialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespStockFinancials>> {
@@ -63,7 +63,7 @@ export class StockfinancialsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id.
+     * Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings, next_dividend; omit it to get the full record, which requires market_id.
      * stockFinancials
      */
     async stockFinancials(requestParameters: StockFinancialsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespStockFinancials> {

package/models/StockFinancial.ts

@@ -25,6 +25,12 @@ import {
     StockFinancialProfileFromJSONTyped,
     StockFinancialProfileToJSON,
 } from './StockFinancialProfile';
+import type { StockFinancialDividends } from './StockFinancialDividends';
+import {
+    StockFinancialDividendsFromJSON,
+    StockFinancialDividendsFromJSONTyped,
+    StockFinancialDividendsToJSON,
+} from './StockFinancialDividends';
 import type { StockFinancialEarnings } from './StockFinancialEarnings';
 import {
     StockFinancialEarningsFromJSON,
@@ -56,6 +62,12 @@ export interface StockFinancial {
      * @memberof StockFinancial
      */
     earnings: StockFinancialEarnings;
+    /**
+     * 
+     * @type {StockFinancialDividends}
+     * @memberof StockFinancial
+     */
+    dividends: StockFinancialDividends;
     /**
      * 
      * @type {StockFinancialStatements}
@@ -71,6 +83,7 @@ export function instanceOfStockFinancial(value: object): value is StockFinancial
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
     if (!('profile' in value) || value['profile'] === undefined) return false;
     if (!('earnings' in value) || value['earnings'] === undefined) return false;
+    if (!('dividends' in value) || value['dividends'] === undefined) return false;
     if (!('statements' in value) || value['statements'] === undefined) return false;
     return true;
 }
@@ -88,6 +101,7 @@ export function StockFinancialFromJSONTyped(json: any, ignoreDiscriminator: bool
         'market_id': json['market_id'],
         'profile': StockFinancialProfileFromJSON(json['profile']),
         'earnings': StockFinancialEarningsFromJSON(json['earnings']),
+        'dividends': StockFinancialDividendsFromJSON(json['dividends']),
         'statements': StockFinancialStatementsFromJSON(json['statements']),
     };
 }
@@ -101,6 +115,7 @@ export function StockFinancialToJSON(value?: StockFinancial | null): any {
         'market_id': value['market_id'],
         'profile': StockFinancialProfileToJSON(value['profile']),
         'earnings': StockFinancialEarningsToJSON(value['earnings']),
+        'dividends': StockFinancialDividendsToJSON(value['dividends']),
         'statements': StockFinancialStatementsToJSON(value['statements']),
     };
 }

package/models/StockFinancialDividendEvent.ts

@@ -0,0 +1,153 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface StockFinancialDividendEvent
+ */
+export interface StockFinancialDividendEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    source: StockFinancialDividendEventSourceEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    ex_date: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    record_date: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    payment_date: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    declaration_date: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StockFinancialDividendEvent
+     */
+    amount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StockFinancialDividendEvent
+     */
+    adj_amount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    frequency: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    currency: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StockFinancialDividendEvent
+     */
+    status: string;
+}
+
+
+/**
+ * @export
+ */
+export const StockFinancialDividendEventSourceEnum = {
+    Fmp: 'fmp',
+    Robinhood: 'robinhood'
+} as const;
+export type StockFinancialDividendEventSourceEnum = typeof StockFinancialDividendEventSourceEnum[keyof typeof StockFinancialDividendEventSourceEnum];
+
+
+/**
+ * Check if a given object implements the StockFinancialDividendEvent interface.
+ */
+export function instanceOfStockFinancialDividendEvent(value: object): value is StockFinancialDividendEvent {
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('ex_date' in value) || value['ex_date'] === undefined) return false;
+    if (!('record_date' in value) || value['record_date'] === undefined) return false;
+    if (!('payment_date' in value) || value['payment_date'] === undefined) return false;
+    if (!('declaration_date' in value) || value['declaration_date'] === undefined) return false;
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('adj_amount' in value) || value['adj_amount'] === undefined) return false;
+    if (!('frequency' in value) || value['frequency'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function StockFinancialDividendEventFromJSON(json: any): StockFinancialDividendEvent {
+    return StockFinancialDividendEventFromJSONTyped(json, false);
+}
+
+export function StockFinancialDividendEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): StockFinancialDividendEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'source': json['source'],
+        'ex_date': json['ex_date'],
+        'record_date': json['record_date'],
+        'payment_date': json['payment_date'],
+        'declaration_date': json['declaration_date'],
+        'amount': json['amount'],
+        'adj_amount': json['adj_amount'],
+        'frequency': json['frequency'],
+        'currency': json['currency'],
+        'status': json['status'],
+    };
+}
+
+export function StockFinancialDividendEventToJSON(value?: StockFinancialDividendEvent | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'source': value['source'],
+        'ex_date': value['ex_date'],
+        'record_date': value['record_date'],
+        'payment_date': value['payment_date'],
+        'declaration_date': value['declaration_date'],
+        'amount': value['amount'],
+        'adj_amount': value['adj_amount'],
+        'frequency': value['frequency'],
+        'currency': value['currency'],
+        'status': value['status'],
+    };
+}
+

package/models/StockFinancialDividends.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { StockFinancialDividendEvent } from './StockFinancialDividendEvent';
+import {
+    StockFinancialDividendEventFromJSON,
+    StockFinancialDividendEventFromJSONTyped,
+    StockFinancialDividendEventToJSON,
+} from './StockFinancialDividendEvent';
+
+/**
+ * 
+ * @export
+ * @interface StockFinancialDividends
+ */
+export interface StockFinancialDividends {
+    /**
+     * 
+     * @type {StockFinancialDividendEvent}
+     * @memberof StockFinancialDividends
+     */
+    next?: StockFinancialDividendEvent;
+    /**
+     * 
+     * @type {Array<StockFinancialDividendEvent>}
+     * @memberof StockFinancialDividends
+     */
+    history: Array<StockFinancialDividendEvent>;
+    /**
+     * 
+     * @type {Array<StockFinancialDividendEvent>}
+     * @memberof StockFinancialDividends
+     */
+    distributions: Array<StockFinancialDividendEvent>;
+}
+
+/**
+ * Check if a given object implements the StockFinancialDividends interface.
+ */
+export function instanceOfStockFinancialDividends(value: object): value is StockFinancialDividends {
+    if (!('history' in value) || value['history'] === undefined) return false;
+    if (!('distributions' in value) || value['distributions'] === undefined) return false;
+    return true;
+}
+
+export function StockFinancialDividendsFromJSON(json: any): StockFinancialDividends {
+    return StockFinancialDividendsFromJSONTyped(json, false);
+}
+
+export function StockFinancialDividendsFromJSONTyped(json: any, ignoreDiscriminator: boolean): StockFinancialDividends {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'next': json['next'] == null ? undefined : StockFinancialDividendEventFromJSON(json['next']),
+        'history': ((json['history'] as Array<any>).map(StockFinancialDividendEventFromJSON)),
+        'distributions': ((json['distributions'] as Array<any>).map(StockFinancialDividendEventFromJSON)),
+    };
+}
+
+export function StockFinancialDividendsToJSON(value?: StockFinancialDividends | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'next': StockFinancialDividendEventToJSON(value['next']),
+        'history': ((value['history'] as Array<any>).map(StockFinancialDividendEventToJSON)),
+        'distributions': ((value['distributions'] as Array<any>).map(StockFinancialDividendEventToJSON)),
+    };
+}
+

package/models/TvSymbolInfo.ts

@@ -112,10 +112,10 @@ export interface TvSymbolInfo {
     has_intraday: boolean;
     /**
      * 
-     * @type {boolean}
+     * @type {Array<boolean>}
      * @memberof TvSymbolInfo
      */
-    has_no_volume: boolean;
+    has_no_volume: Array<boolean>;
     /**
      * 
      * @type {boolean}

package/models/index.ts

@@ -237,6 +237,8 @@ export * from './Status';
 export * from './StockBalanceSheet';
 export * from './StockCashFlowStatement';
 export * from './StockFinancial';
+export * from './StockFinancialDividendEvent';
+export * from './StockFinancialDividends';
 export * from './StockFinancialEarnings';
 export * from './StockFinancialEarningsEvent';
 export * from './StockFinancialHistoricalEarning';

package/openapi.json

@@ -4832,7 +4832,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings; omit it to get the full record, which requires market_id."
+        "description": "Get stock financials. Returns stock_financial for a single market_id, or stock_financials for every stock market when market_id is omitted. fields narrows the response to a subset of currency, exchange, industry, sector, country, market_cap, next_earnings, next_dividend; omit it to get the full record, which requires market_id."
       }
     },
     "/api/v1/syntheticSpotInfo": {
@@ -15548,6 +15548,9 @@
         "earnings": {
           "$ref": "#/definitions/StockFinancialEarnings"
         },
+        "dividends": {
+          "$ref": "#/definitions/StockFinancialDividends"
+        },
         "statements": {
           "$ref": "#/definitions/StockFinancialStatements"
         }
@@ -15557,9 +15560,89 @@
         "market_id",
         "profile",
         "earnings",
+        "dividends",
         "statements"
       ]
     },
+    "StockFinancialDividendEvent": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string",
+          "enum": [
+            "fmp",
+            "robinhood"
+          ]
+        },
+        "ex_date": {
+          "type": "string"
+        },
+        "record_date": {
+          "type": "string"
+        },
+        "payment_date": {
+          "type": "string"
+        },
+        "declaration_date": {
+          "type": "string"
+        },
+        "amount": {
+          "type": "number",
+          "format": "double"
+        },
+        "adj_amount": {
+          "type": "number",
+          "format": "double"
+        },
+        "frequency": {
+          "type": "string"
+        },
+        "currency": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        }
+      },
+      "title": "StockFinancialDividendEvent",
+      "required": [
+        "source",
+        "ex_date",
+        "record_date",
+        "payment_date",
+        "declaration_date",
+        "amount",
+        "adj_amount",
+        "frequency",
+        "currency",
+        "status"
+      ]
+    },
+    "StockFinancialDividends": {
+      "type": "object",
+      "properties": {
+        "next": {
+          "$ref": "#/definitions/StockFinancialDividendEvent"
+        },
+        "history": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/StockFinancialDividendEvent"
+          }
+        },
+        "distributions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/StockFinancialDividendEvent"
+          }
+        }
+      },
+      "title": "StockFinancialDividends",
+      "required": [
+        "history",
+        "distributions"
+      ]
+    },
     "StockFinancialEarnings": {
       "type": "object",
       "properties": {
@@ -16859,8 +16942,10 @@
           "format": "boolean"
         },
         "has-no-volume": {
-          "type": "boolean",
-          "format": "boolean"
+          "type": "array",
+          "items": {
+            "type": "boolean"
+          }
         },
         "has-daily": {
           "type": "boolean",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.302",
+  "version": "1.0.304",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {
@@ -8,8 +8,11 @@
     "test": "test"
   },
   "scripts": {
+    "prepare": "node -e \"require('fs').existsSync('.git')&&require('child_process').execFileSync('git',['config','core.hooksPath','.githooks'])\"",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "scan:secrets": "secretlint \"**/*\"",
+    "prepublishOnly": "npm run scan:secrets"
   },
   "repository": {
     "type": "git",
@@ -22,6 +25,8 @@
   },
   "homepage": "https://github.com/elliottech/zklighter-perps-ts#readme",
   "devDependencies": {
+    "@secretlint/secretlint-rule-preset-recommend": "13.0.5",
+    "secretlint": "13.0.5",
     "typescript": "7.0.2"
   }
 }

package/.circleci/config.yml

@@ -1,291 +0,0 @@
-version: 2.1
-
-jobs:
-  update_openapi:
-    docker:
-      - image: cimg/go:1.22.5
-
-    working_directory: ~/project
-
-    steps:
-      - checkout
-
-      - run:
-          name: Clone zklighter-perps repository
-          command: |
-            git clone -b << pipeline.parameters.BE_BRANCH >> --depth 1 https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps.git
-
-      - run:
-          name: Download goctl-swagger binary
-          command: |
-            mv goctl-swagger-amd zklighter-perps/service/apiserver
-            cd zklighter-perps/service/apiserver
-            chmod +x goctl-swagger-amd
-
-      - run:
-          name: Run goctl api plugin
-          command: |
-            cd zklighter-perps/service/apiserver
-            GO111MODULE=on go install github.com/zeromicro/go-zero/tools/goctl@v1.6.6
-            sed 's/struct{}/{}/g' server.api > temp.txt && cp temp.txt server.api && rm temp.txt
-            goctl api plugin --plugin ./goctl-swagger-amd="swagger -filename openapi.json -host mainnet.zklighter.elliot.ai -schemes https" --api server.api --dir .
-
-      # NOTE: all openapi.json post-processing now lives in the dedicated
-      # `openapi_postprocess` job (.circleci/openapi_postprocess.py). This job
-      # only generates and persists the raw spec. See README.md.
-
-      - store_artifacts:
-          path: ~/project/zklighter-perps/service/apiserver/openapi.json
-
-      - persist_to_workspace:
-          root: ~/project/zklighter-perps/service/apiserver
-          paths:
-            - openapi.json
-
-  openapi_postprocess:
-    docker:
-      - image: cimg/python:3.10.0
-    working_directory: ~/project
-    steps:
-      - checkout
-
-      - attach_workspace:
-          at: /tmp/workspace
-
-      - run:
-          name: Get openapi.json from workspace
-          command: |
-            cp /tmp/workspace/openapi.json ./.circleci
-
-      - run:
-          name: Run postprocess script
-          command: |
-            cd ./.circleci
-            python3 openapi_postprocess.py
-
-      - store_artifacts:
-          path: ~/project/.circleci/openapi.json
-
-      - persist_to_workspace:
-          root: ~/project/.circleci
-          paths:
-            - openapi.json
-
-  update_ts_sdk:
-    docker:
-      - image: cimg/openjdk:21.0.2
-    working_directory: ~/project
-    steps:
-      - checkout
-
-      - attach_workspace:
-          at: /tmp/workspace
-
-      - run:
-          name: Get openapi.json from workspace
-          command: |
-            cp /tmp/workspace/openapi.json .
-
-      - run:
-          name: Download OpenAPI Generator JAR
-          command: |
-            wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.7.0/openapi-generator-cli-7.7.0.jar -O openapi-generator-cli.jar
-
-      - run:
-          name: Generate TS client using OpenAPI Generator
-          command: |
-            java -jar openapi-generator-cli.jar generate -i ./openapi.json -g typescript-fetch -o . -c config.yaml
-      - run:
-          name: git status
-          command: |
-            if git status | grep -q "nothing to commit"; then 
-                exit 1; 
-            fi
-      - run:
-          name: Increase package version
-          command: |
-            jq '.version |= (split(".") | .[2] = ((.[2] | tonumber) + 1 | tostring) | join("."))' package.json > tmp.json && mv tmp.json package.json
-
-      - run:
-          name: push to new branch
-          command: |
-            git remote remove origin
-            git remote add origin https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps-ts
-
-            git config --global user.email "hasan@circleci.com"
-            git config --global user.name "CircleCI Hasan"
-            export BRANCH_NAME=`date +%s`
-            git checkout -b $BRANCH_NAME
-            git add .
-            git commit -m "Update SDK"
-            git push origin $BRANCH_NAME
-
-            BE_BRANCH=<< pipeline.parameters.BE_BRANCH >>
-
-            PR_URL=$(curl -X POST -H "Authorization: Bearer ${GITHUB_TOKEN}" -d '{"title": "'$BE_BRANCH'", "head": "'$BRANCH_NAME'", "base": "main"}' https://api.github.com/repos/elliottech/zklighter-perps-ts/pulls | jq -r '.html_url')
-            curl -X POST -H 'Content-type: application/json' --data '{"text":"TypeScript SDK has been updated. Check the PR here: '$PR_URL'", "type": "mrkdwn"}' ${SLACK_URL}
-
-  typecheck:
-    docker:
-      - image: cimg/node:22.4.1
-
-    working_directory: ~/project
-
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: |
-            npm install
-      - run:
-          name: Type-check generated SDK
-          command: |
-            npm run typecheck
-
-  update_npm_package:
-    docker:
-      - image: cimg/node:22.4.1
-
-    steps:
-      - checkout
-      - run:
-          name: Remove binaries
-          command: |
-            rm -rf goctl-swagger-amd
-            rm -rf openapi-generator-cli.jar
-      - run:
-          name: Publish npm package
-          command: |
-            VERSION=$(jq -r .version package.json)
-            if npm view "zklighter-perps@${VERSION}" version > /dev/null 2>&1; then
-              echo "zklighter-perps@${VERSION} is already published; skipping"
-              exit 0
-            fi
-            git config --global user.email "hasan@lighter.xyz"
-            git config --global user.name "CircleCI Hasan"
-            npm set //registry.npmjs.org/:_authToken=$NPM_TOKEN
-            npm publish
-
-  publish_prerelease:
-    docker:
-      - image: cimg/node:22.4.1
-
-    steps:
-      - checkout
-      - run:
-          name: Find open PR for branch
-          command: |
-            PR_NUMBER=$(curl -s -H "Authorization: Bearer ${GITHUB_TOKEN}" \
-              "https://api.github.com/repos/elliottech/zklighter-perps-ts/pulls?head=elliottech:${CIRCLE_BRANCH}&state=open" \
-              | jq -r '.[0].number // empty')
-            if [ -z "$PR_NUMBER" ]; then
-              echo "No open PR for branch ${CIRCLE_BRANCH}; skipping prerelease publish"
-              circleci-agent step halt
-            else
-              echo "Found PR #${PR_NUMBER}"
-              echo "export PR_NUMBER=${PR_NUMBER}" >> "$BASH_ENV"
-            fi
-      - run:
-          name: Generate prerelease version
-          command: |
-            CLEAN_BRANCH_NAME=$(echo "$CIRCLE_BRANCH" | sed 's/[^a-zA-Z0-9-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
-            # npm rejects dist-tags that parse as a semver range (e.g. an
-            # all-numeric branch name), so prefix those.
-            if echo "$CLEAN_BRANCH_NAME" | grep -Eq '^[0-9]+$'; then
-              CLEAN_BRANCH_NAME="branch-${CLEAN_BRANCH_NAME}"
-            fi
-            CLEAN_ACTOR=$(echo "${CIRCLE_USERNAME:-circleci}" | sed 's/[^a-zA-Z0-9-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
-            COMMIT_SHA=$(echo "$CIRCLE_SHA1" | cut -c1-7)
-
-            # Semver-compatible version: 0.PR_NUMBER.0-ACTOR.COMMIT_SHA.BRANCH_NAME
-            # Always < 1.0.0 so it can never shadow a real release.
-            PRERELEASE_VERSION="0.${PR_NUMBER}.0-${CLEAN_ACTOR}.${COMMIT_SHA}.${CLEAN_BRANCH_NAME}"
-            echo "Prerelease version: $PRERELEASE_VERSION"
-
-            echo "export CLEAN_BRANCH_NAME=${CLEAN_BRANCH_NAME}" >> "$BASH_ENV"
-            echo "export PRERELEASE_VERSION=${PRERELEASE_VERSION}" >> "$BASH_ENV"
-      - run:
-          name: Remove binaries
-          command: |
-            rm -rf goctl-swagger-amd
-            rm -rf openapi-generator-cli.jar
-      - run:
-          name: Publish prerelease npm package
-          command: |
-            jq --arg v "$PRERELEASE_VERSION" '.version = $v' package.json > tmp.json && mv tmp.json package.json
-            npm set //registry.npmjs.org/:_authToken=$NPM_TOKEN
-            npm publish --tag "$CLEAN_BRANCH_NAME"
-      - run:
-          name: Comment on PR
-          command: |
-            COMMENT_BODY=$(jq -n --arg version "$PRERELEASE_VERSION" --arg tag "$CLEAN_BRANCH_NAME" \
-              '{body: ("## 🚀 Prerelease Published\n\n**Version:** `" + $version + "`\n**Tag:** `" + $tag + "`\n\n### Update package.json:\n```json\n\"zklighter-perps\": \"" + $version + "\"\n```")}')
-
-            EXISTING_COMMENT_ID=$(curl -s -H "Authorization: Bearer ${GITHUB_TOKEN}" \
-              "https://api.github.com/repos/elliottech/zklighter-perps-ts/issues/${PR_NUMBER}/comments?per_page=100" \
-              | jq -r '[.[] | select(.body | contains("🚀 Prerelease Published"))][0].id // empty')
-
-            if [ -n "$EXISTING_COMMENT_ID" ]; then
-              curl -s -X PATCH -H "Authorization: Bearer ${GITHUB_TOKEN}" \
-                -d "$COMMENT_BODY" \
-                "https://api.github.com/repos/elliottech/zklighter-perps-ts/issues/comments/${EXISTING_COMMENT_ID}" > /dev/null
-            else
-              curl -s -X POST -H "Authorization: Bearer ${GITHUB_TOKEN}" \
-                -d "$COMMENT_BODY" \
-                "https://api.github.com/repos/elliottech/zklighter-perps-ts/issues/${PR_NUMBER}/comments" > /dev/null
-            fi
-
-parameters:
-  update_ts_sdk:
-    default: false
-    type: boolean
-  BE_BRANCH:
-    type: string
-    default: "main"
-
-workflows:
-  version: 2
-  update_ts_sdk:
-    when: << pipeline.parameters.update_ts_sdk >>
-    jobs:
-      - update_openapi:
-          filters:
-            branches:
-              only: main
-      - openapi_postprocess:
-          filters:
-            branches:
-              only: main
-          requires:
-            - update_openapi
-      - update_ts_sdk:
-          filters:
-            branches:
-              only: main
-          requires:
-            - openapi_postprocess
-
-  update_npm_package:
-    when:
-      not: << pipeline.parameters.update_ts_sdk >>
-    jobs:
-      # Runs on every branch (including the timestamped branches opened by the
-      # update_ts_sdk workflow) so a regenerated SDK that would break consumers
-      # fails its PR check before merge.
-      - typecheck
-      - update_npm_package:
-          filters:
-            branches:
-              only: main
-          requires:
-            - typecheck
-      # Publishes a PR prerelease (version 0.PR.0-actor.sha.branch, dist-tag =
-      # branch name) and posts/updates a PR comment with the version to use,
-      # mirroring the prerelease flow in zklighter-react-store.
-      - publish_prerelease:
-          filters:
-            branches:
-              ignore: main
-          requires:
-            - typecheck
-

package/.circleci/openapi_postprocess.py

@@ -1,366 +0,0 @@
-"""Post-process the swagger/openapi.json before the TypeScript SDK is generated.
-
-This is the single source of truth for every transformation applied to the
-spec emitted by goctl-swagger. The raw spec has a number of quirks (empty keys,
-non-standard int16 types, missing error responses, placeholder enum values,
-auto-generated operation ids, etc.) that either break the OpenAPI Generator or
-produce an awkward SDK. See README.md ("OpenAPI post-processing") for the
-rationale behind each step.
-
-Previously some of these fixes lived as inline `jq`/`sed` commands in the
-`update_openapi` CI job. They have been consolidated here so the logic is in one
-place, testable, and easy to reason about.
-
-The steps below run in the same order they used to run in the pipeline:
-the former `jq`/`sed` transforms first, then the original Python transforms.
-"""
-
-import json
-
-FILE = "./openapi.json"
-
-
-def walk(node, fn):
-    """Apply ``fn`` to every node bottom-up, mirroring jq's ``walk``.
-
-    Children are transformed before their parent so ``fn`` always sees
-    already-processed sub-trees, matching the semantics of the jq commands
-    these helpers replaced.
-    """
-    if isinstance(node, dict):
-        node = {key: walk(value, fn) for key, value in node.items()}
-    elif isinstance(node, list):
-        node = [walk(item, fn) for item in node]
-    return fn(node)
-
-
-with open(FILE, "r") as f:
-    data = json.load(f)
-
-# ---------------------------------------------------------------------------
-# Step 1. Drop endpoints/definitions that must not be part of the public SDK.
-#   (was: jq 'del(.paths[...], .definitions["ReqSendFeedback"])')
-# ---------------------------------------------------------------------------
-for dropped_path in [
-    "/api/v1/feedback",
-    "/api/v1/ws_status",
-    "/stream",
-    "/api/v1/permission",
-]:
-    data.get("paths", {}).pop(dropped_path, None)
-data.get("definitions", {}).pop("ReqSendFeedback", None)
-
-
-# ---------------------------------------------------------------------------
-# Step 2. Remove empty-string keys emitted by the swagger generator, which the
-#         OpenAPI Generator cannot handle.
-#   (was: jq 'walk(... with_entries(select(.key != "")) ...)')
-# ---------------------------------------------------------------------------
-def _strip_empty_keys(node):
-    if isinstance(node, dict):
-        return {key: value for key, value in node.items() if key != ""}
-    return node
-
-
-data = walk(data, _strip_empty_keys)
-
-
-# ---------------------------------------------------------------------------
-# Step 3. Mirror `summary` into `description` so generated SDK doc comments keep
-#         the original human-readable text before `summary` is overwritten below.
-#   (was: jq 'walk(if has("summary") then .description = .summary end)')
-# ---------------------------------------------------------------------------
-def _summary_to_description(node):
-    if isinstance(node, dict) and "summary" in node:
-        node["description"] = node["summary"]
-    return node
-
-
-data = walk(data, _summary_to_description)
-
-
-# ---------------------------------------------------------------------------
-# Step 4. Seed `summary` from `operationId` (Step 8 may refine it per-path).
-#   (was: jq 'walk(if has("operationId") then .summary = .operationId end)')
-# ---------------------------------------------------------------------------
-def _operation_id_to_summary(node):
-    if isinstance(node, dict) and "operationId" in node:
-        node["summary"] = node["operationId"]
-    return node
-
-
-data = walk(data, _operation_id_to_summary)
-
-
-# ---------------------------------------------------------------------------
-# Step 5. Give every operation a documented 400 response referencing ResultCode.
-#   (was: jq 'walk(if has("responses") then .responses["400"] = {...} end)')
-# ---------------------------------------------------------------------------
-def _add_bad_request_response(node):
-    if isinstance(node, dict) and isinstance(node.get("responses"), dict):
-        node["responses"]["400"] = {
-            "description": "Bad request",
-            "schema": {"$ref": "#/definitions/ResultCode"},
-        }
-    return node
-
-
-data = walk(data, _add_bad_request_response)
-
-
-# ---------------------------------------------------------------------------
-# Step 6. Restore array request parameters from their request definitions. The
-#         generator preserves arrays in definitions but flattens them in path
-#         parameters.
-# ---------------------------------------------------------------------------
-def restore_array_parameters(data):
-    definitions = data.get("definitions", {})
-
-    for path_item in data.get("paths", {}).values():
-        for operation in path_item.values():
-            if not isinstance(operation, dict):
-                continue
-
-            request = definitions.get(f"Req{operation.get('operationId')}", {})
-            properties = request.get("properties", {})
-
-            for parameter in operation.get("parameters", []):
-                property_schema = properties.get(parameter.get("name"), {})
-                if (
-                    property_schema.get("type") != "array"
-                    or parameter.get("type") == "array"
-                ):
-                    continue
-
-                items = {"type": parameter["type"]}
-                if "format" in parameter:
-                    items["format"] = parameter.pop("format")
-                if "enum" in parameter:
-                    items["enum"] = parameter.pop("enum")
-
-                parameter["type"] = "array"
-                parameter["items"] = items
-
-
-restore_array_parameters(data)
-
-
-# ---------------------------------------------------------------------------
-# Step 7. Remove placeholder "-" values from enum/array lists.
-#         The former `sed 's/"-",//g'` only stripped a "-" element when it was
-#         followed by another element (i.e. not the last item); we preserve that
-#         behaviour here.
-# ---------------------------------------------------------------------------
-def _drop_dash_values(node):
-    if isinstance(node, list):
-        last_index = len(node) - 1
-        return [
-            value
-            for index, value in enumerate(node)
-            if not (value == "-" and index != last_index)
-        ]
-    return node
-
-
-data = walk(data, _drop_dash_values)
-
-
-# ---------------------------------------------------------------------------
-# Step 8. Derive stable, path-based operationId/summary so generated method
-#         names are predictable (e.g. /api/v1/account -> "account").
-# ---------------------------------------------------------------------------
-for path in data["paths"]:
-    methods = list(data["paths"][path].keys())
-    has_multiple_methods = len(methods) > 1
-
-    for method in methods:
-        if "api/v1/" in path:
-            base_name = path.split("api/v1/")[1].replace("/", "_")
-            data["paths"][path][method]["summary"] = base_name
-            if has_multiple_methods:
-                data["paths"][path][method]["operationId"] = f"{base_name}_{method}"
-            else:
-                data["paths"][path][method]["operationId"] = base_name
-        elif "api/v2/" in path:
-            base_name = path.split("api/v2/")[1].replace("/", "_") + "_v2"
-            data["paths"][path][method]["summary"] = base_name
-            if has_multiple_methods:
-                data["paths"][path][method]["operationId"] = f"{base_name}_{method}"
-            else:
-                data["paths"][path][method]["operationId"] = base_name
-        else:
-            base_name = path.split("/")[-1]
-            data["paths"][path][method]["summary"] = base_name
-            if has_multiple_methods:
-                data["paths"][path][method]["operationId"] = f"{base_name}_{method}"
-            else:
-                data["paths"][path][method]["operationId"] = base_name
-
-        if data["paths"][path][method]["summary"] == "":
-            data["paths"][path][method]["summary"] = "status"
-            if has_multiple_methods:
-                data["paths"][path][method]["operationId"] = f"status_{method}"
-            else:
-                data["paths"][path][method]["operationId"] = "status"
-
-# Replace $ref to int16/float64 types with inline equivalents across all
-# definitions. int16, float64 and derived map types are not standard OpenAPI
-# and cause the generator to emit broken model references.
-def replace_int16_refs(obj):
-    if isinstance(obj, dict):
-        if obj.get("$ref") == "#/definitions/int16":
-            return {"type": "integer", "format": "int64"}
-        if obj.get("$ref") == "#/definitions/float64":
-            return {"type": "number", "format": "double"}
-        if obj.get("$ref") == "#/definitions/mapint16string":
-            return {"type": "object", "additionalProperties": {"type": "string"}}
-        if obj.get("$ref") == "#/definitions/mapstringfloat64":
-            return {"type": "object", "additionalProperties": {"type": "number", "format": "double"}}
-        return {k: replace_int16_refs(v) for k, v in obj.items()}
-    if isinstance(obj, list):
-        return [replace_int16_refs(i) for i in obj]
-    return obj
-
-for defn_name in list(data["definitions"]):
-    data["definitions"][defn_name] = replace_int16_refs(
-        data["definitions"][defn_name]
-    )
-
-# Fix enum placement for array types: move enum from array level into items
-for defn in data["definitions"].values():
-    for prop in defn.get("properties", {}).values():
-        if prop.get("type") == "array" and "enum" in prop:
-            prop["items"]["enum"] = prop.pop("enum")
-
-# goctl-swagger does not preserve Go pointer types. Restore nullability for
-# stock-financial fields that are always present but may contain JSON null.
-nullable_properties = {
-    "StockBalanceSheet": {
-        "cash_and_cash_equivalents",
-        "total_assets",
-        "total_liabilities",
-        "total_equity",
-        "total_debt",
-        "net_debt",
-    },
-    "StockCashFlowStatement": {
-        "operating_cash_flow",
-        "capital_expenditure",
-        "free_cash_flow",
-    },
-    "StockFinancialEarningsEvent": {
-        "eps_estimated",
-        "revenue_estimated",
-    },
-    "StockFinancialHistoricalEarning": {
-        "eps_estimated",
-        "eps_actual",
-        "revenue_estimated",
-        "revenue_actual",
-    },
-    "StockFinancialProfile": {"market_cap"},
-    "StockIncomeStatement": {
-        "revenue",
-        "gross_profit",
-        "operating_income",
-        "ebitda",
-        "net_income",
-        "eps",
-        "eps_diluted",
-    },
-    "UpcomingEarning": {
-        "eps_estimated",
-        "revenue_estimated",
-    },
-}
-
-for definition_name, property_names in nullable_properties.items():
-    properties = (
-        data["definitions"].get(definition_name, {}).get("properties", {})
-    )
-    for property_name in property_names:
-        if property_name in properties:
-            properties[property_name]["x-nullable"] = True
-
-# These fields use `omitempty` in server.api and are absent when FMP has no
-# value. They are optional rather than nullable in the generated SDK.
-optional_properties = {
-    "RespStockFinancials": {"stock_financials"},
-    "StockFinancialEarnings": {"history"},
-    "StockFinancialEarningsEvent": {"timing"},
-    "StockFinancialPeriod": {"reported_currency"},
-    "StockFinancialProfile": {
-        "currency",
-        "exchange",
-        "industry",
-        "sector",
-        "country",
-    },
-    "StockFinancialStatements": {"annual", "quarterly"},
-    "Token": {"backend_symbol"},
-    "UpcomingEarning": {"currency", "timing"},
-}
-
-for path in data["definitions"]:
-    if not path.startswith("Req"):
-        required_fields = list(data["definitions"][path]["properties"].keys())
-        if "message" in required_fields:
-            required_fields.remove("message")
-
-        if "next" in required_fields:
-            required_fields.remove("next")
-
-        if "next_cursor" in required_fields:
-            required_fields.remove("next_cursor")
-
-        if "account_share" in required_fields:
-            required_fields.remove("account_share")
-
-        if "total_funding_paid_out" in required_fields:
-            required_fields.remove("total_funding_paid_out")
-
-        if "pending_unlocks" in required_fields:
-            required_fields.remove("pending_unlocks")
-
-        if "account_trading_mode" in required_fields:
-            required_fields.remove("account_trading_mode")
-
-        if "funding_fee_discounts_enabled" in required_fields:
-            required_fields.remove("funding_fee_discounts_enabled")
-
-        if "hidden" in required_fields:
-            required_fields.remove("hidden")
-
-        if "approved_integrators" in required_fields:
-            required_fields.remove("approved_integrators")
-
-        if "ask_id_str" in required_fields:
-            required_fields.remove("ask_id_str")
-
-        if "bid_id_str" in required_fields:
-            required_fields.remove("bid_id_str")
-
-        if "market_maker_incentive_account_index" in required_fields:
-            required_fields.remove("market_maker_incentive_account_index")
-
-        if "user_tier_last_update" in required_fields:
-            required_fields.remove("user_tier_last_update")
-
-        if path == "Trade":
-            if "taker_fee" in required_fields:
-                required_fields.remove("taker_fee")
-
-            if "maker_fee" in required_fields:
-                required_fields.remove("maker_fee")
-
-        for field in optional_properties.get(path, set()):
-            if field in required_fields:
-                required_fields.remove(field)
-
-        if len(required_fields) > 0:
-            data["definitions"][path]["required"] = required_fields
-        else:
-            data["definitions"][path].pop("required", None)
-
-with open(FILE, "w") as f:
-    json.dump(data, f, indent=2)