zklighter-perps 1.0.301 → 1.0.303

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/models/OrderBook.ts

@@ -31,6 +31,12 @@ export interface OrderBook {
      * @memberof OrderBook
      */
     market_id: number;
+    /**
+     *  internal only: the reusable tree slot backing this market; never serialized, users only know market_id (the public market index)
+     * @type {number}
+     * @memberof OrderBook
+     */
+    marketSlotId: number;
     /**
      * 
      * @type {string}
@@ -161,6 +167,7 @@ export type OrderBookStatusEnum = typeof OrderBookStatusEnum[keyof typeof OrderB
 export function instanceOfOrderBook(value: object): value is OrderBook {
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
+    if (!('marketSlotId' in value) || value['marketSlotId'] === undefined) return false;
     if (!('market_type' in value) || value['market_type'] === undefined) return false;
     if (!('base_asset_id' in value) || value['base_asset_id'] === undefined) return false;
     if (!('quote_asset_id' in value) || value['quote_asset_id'] === undefined) return false;
@@ -193,6 +200,7 @@ export function OrderBookFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         
         'symbol': json['symbol'],
         'market_id': json['market_id'],
+        'marketSlotId': json['marketSlotId'],
         'market_type': json['market_type'],
         'base_asset_id': json['base_asset_id'],
         'quote_asset_id': json['quote_asset_id'],
@@ -221,6 +229,7 @@ export function OrderBookToJSON(value?: OrderBook | null): any {
         
         'symbol': value['symbol'],
         'market_id': value['market_id'],
+        'marketSlotId': value['marketSlotId'],
         'market_type': value['market_type'],
         'base_asset_id': value['base_asset_id'],
         'quote_asset_id': value['quote_asset_id'],

package/models/PerpsOrderBookDetail.ts

@@ -38,6 +38,12 @@ export interface PerpsOrderBookDetail {
      * @memberof PerpsOrderBookDetail
      */
     market_id: number;
+    /**
+     *  internal only: the reusable tree slot backing this market; never serialized, users only know market_id (the public market index)
+     * @type {number}
+     * @memberof PerpsOrderBookDetail
+     */
+    marketSlotId: number;
     /**
      * 
      * @type {string}
@@ -318,6 +324,7 @@ export type PerpsOrderBookDetailStatusEnum = typeof PerpsOrderBookDetailStatusEn
 export function instanceOfPerpsOrderBookDetail(value: object): value is PerpsOrderBookDetail {
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
+    if (!('marketSlotId' in value) || value['marketSlotId'] === undefined) return false;
     if (!('market_type' in value) || value['market_type'] === undefined) return false;
     if (!('base_asset_id' in value) || value['base_asset_id'] === undefined) return false;
     if (!('quote_asset_id' in value) || value['quote_asset_id'] === undefined) return false;
@@ -375,6 +382,7 @@ export function PerpsOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator
         
         'symbol': json['symbol'],
         'market_id': json['market_id'],
+        'marketSlotId': json['marketSlotId'],
         'market_type': json['market_type'],
         'base_asset_id': json['base_asset_id'],
         'quote_asset_id': json['quote_asset_id'],
@@ -428,6 +436,7 @@ export function PerpsOrderBookDetailToJSON(value?: PerpsOrderBookDetail | null):
         
         'symbol': value['symbol'],
         'market_id': value['market_id'],
+        'marketSlotId': value['marketSlotId'],
         'market_type': value['market_type'],
         'base_asset_id': value['base_asset_id'],
         'quote_asset_id': value['quote_asset_id'],

package/models/RFQEntry.ts

@@ -73,7 +73,7 @@ export interface RFQEntry {
      * @type {string}
      * @memberof RFQEntry
      */
-    status: string;
+    status: RFQEntryStatusEnum;
     /**
      * 
      * @type {RFQMetadata}
@@ -100,6 +100,18 @@ export interface RFQEntry {
     updated_at: number;
 }
 
+
+/**
+ * @export
+ */
+export const RFQEntryStatusEnum = {
+    Opened: 'opened',
+    OrderCreated: 'order_created',
+    Closed: 'closed'
+} as const;
+export type RFQEntryStatusEnum = typeof RFQEntryStatusEnum[keyof typeof RFQEntryStatusEnum];
+
+
 /**
  * Check if a given object implements the RFQEntry interface.
  */

package/models/RespCreateRFQ.ts

@@ -85,7 +85,7 @@ export interface RespCreateRFQ {
      * @type {string}
      * @memberof RespCreateRFQ
      */
-    status: string;
+    status: RespCreateRFQStatusEnum;
     /**
      * 
      * @type {RFQMetadata}
@@ -112,6 +112,18 @@ export interface RespCreateRFQ {
     updated_at: number;
 }
 
+
+/**
+ * @export
+ */
+export const RespCreateRFQStatusEnum = {
+    Opened: 'opened',
+    OrderCreated: 'order_created',
+    Closed: 'closed'
+} as const;
+export type RespCreateRFQStatusEnum = typeof RespCreateRFQStatusEnum[keyof typeof RespCreateRFQStatusEnum];
+
+
 /**
  * Check if a given object implements the RespCreateRFQ interface.
  */

package/models/RespGetRFQ.ts

@@ -85,7 +85,7 @@ export interface RespGetRFQ {
      * @type {string}
      * @memberof RespGetRFQ
      */
-    status: string;
+    status: RespGetRFQStatusEnum;
     /**
      * 
      * @type {RFQMetadata}
@@ -112,6 +112,18 @@ export interface RespGetRFQ {
     updated_at: number;
 }
 
+
+/**
+ * @export
+ */
+export const RespGetRFQStatusEnum = {
+    Opened: 'opened',
+    OrderCreated: 'order_created',
+    Closed: 'closed'
+} as const;
+export type RespGetRFQStatusEnum = typeof RespGetRFQStatusEnum[keyof typeof RespGetRFQStatusEnum];
+
+
 /**
  * Check if a given object implements the RespGetRFQ interface.
  */

package/models/RespRespondToRFQ.ts

@@ -85,7 +85,7 @@ export interface RespRespondToRFQ {
      * @type {string}
      * @memberof RespRespondToRFQ
      */
-    status: string;
+    status: RespRespondToRFQStatusEnum;
     /**
      * 
      * @type {RFQMetadata}
@@ -112,6 +112,18 @@ export interface RespRespondToRFQ {
     updated_at: number;
 }
 
+
+/**
+ * @export
+ */
+export const RespRespondToRFQStatusEnum = {
+    Opened: 'opened',
+    OrderCreated: 'order_created',
+    Closed: 'closed'
+} as const;
+export type RespRespondToRFQStatusEnum = typeof RespRespondToRFQStatusEnum[keyof typeof RespRespondToRFQStatusEnum];
+
+
 /**
  * Check if a given object implements the RespRespondToRFQ interface.
  */

package/models/RespUpdateRFQ.ts

@@ -85,7 +85,7 @@ export interface RespUpdateRFQ {
      * @type {string}
      * @memberof RespUpdateRFQ
      */
-    status: string;
+    status: RespUpdateRFQStatusEnum;
     /**
      * 
      * @type {RFQMetadata}
@@ -112,6 +112,18 @@ export interface RespUpdateRFQ {
     updated_at: number;
 }
 
+
+/**
+ * @export
+ */
+export const RespUpdateRFQStatusEnum = {
+    Opened: 'opened',
+    OrderCreated: 'order_created',
+    Closed: 'closed'
+} as const;
+export type RespUpdateRFQStatusEnum = typeof RespUpdateRFQStatusEnum[keyof typeof RespUpdateRFQStatusEnum];
+
+
 /**
  * Check if a given object implements the RespUpdateRFQ interface.
  */

package/models/SpotOrderBookDetail.ts

@@ -31,6 +31,12 @@ export interface SpotOrderBookDetail {
      * @memberof SpotOrderBookDetail
      */
     market_id: number;
+    /**
+     *  internal only: the reusable tree slot backing this market; never serialized, users only know market_id (the public market index)
+     * @type {number}
+     * @memberof SpotOrderBookDetail
+     */
+    marketSlotId: number;
     /**
      * 
      * @type {string}
@@ -221,6 +227,7 @@ export type SpotOrderBookDetailStatusEnum = typeof SpotOrderBookDetailStatusEnum
 export function instanceOfSpotOrderBookDetail(value: object): value is SpotOrderBookDetail {
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
+    if (!('marketSlotId' in value) || value['marketSlotId'] === undefined) return false;
     if (!('market_type' in value) || value['market_type'] === undefined) return false;
     if (!('base_asset_id' in value) || value['base_asset_id'] === undefined) return false;
     if (!('quote_asset_id' in value) || value['quote_asset_id'] === undefined) return false;
@@ -263,6 +270,7 @@ export function SpotOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator:
         
         'symbol': json['symbol'],
         'market_id': json['market_id'],
+        'marketSlotId': json['marketSlotId'],
         'market_type': json['market_type'],
         'base_asset_id': json['base_asset_id'],
         'quote_asset_id': json['quote_asset_id'],
@@ -301,6 +309,7 @@ export function SpotOrderBookDetailToJSON(value?: SpotOrderBookDetail | null): a
         
         'symbol': value['symbol'],
         'market_id': value['market_id'],
+        'marketSlotId': value['marketSlotId'],
         'market_type': value['market_type'],
         'base_asset_id': value['base_asset_id'],
         'quote_asset_id': value['quote_asset_id'],