zklighter-perps 1.0.285 → 1.0.287

package/.circleci/config.yml

@@ -156,11 +156,80 @@ jobs:
       - 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')
+            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
@@ -205,4 +274,13 @@ workflows:
               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/README.md

@@ -29,7 +29,13 @@ The `update_npm_package` workflow runs on `main`:
   [`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).
+- **`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`.
 
 ## OpenAPI post-processing
 

package/apis/LivepointsApi.ts

@@ -0,0 +1,86 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  LivePointsTotal,
+  ResultCode,
+} from '../models/index';
+import {
+    LivePointsTotalFromJSON,
+    LivePointsTotalToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface LivePointsTotalRequest {
+    account_index: number;
+    authorization?: string;
+    auth?: string;
+}
+
+/**
+ * 
+ */
+export class LivepointsApi extends runtime.BaseAPI {
+
+    /**
+     * Get RH live points total for an account
+     * livePoints_total
+     */
+    async livePointsTotalRaw(requestParameters: LivePointsTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LivePointsTotal>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling livePointsTotal().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['authorization'] != null) {
+            queryParameters['authorization'] = requestParameters['authorization'];
+        }
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/livePoints/total`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LivePointsTotalFromJSON(jsonValue));
+    }
+
+    /**
+     * Get RH live points total for an account
+     * livePoints_total
+     */
+    async livePointsTotal(requestParameters: LivePointsTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LivePointsTotal> {
+        const response = await this.livePointsTotalRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/models/LivePointsTotal.ts

@@ -0,0 +1,78 @@
+/* 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 LivePointsTotal
+ */
+export interface LivePointsTotal {
+    /**
+     * 
+     * @type {number}
+     * @memberof LivePointsTotal
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof LivePointsTotal
+     */
+    message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LivePointsTotal
+     */
+    total_live_points: number;
+}
+
+/**
+ * Check if a given object implements the LivePointsTotal interface.
+ */
+export function instanceOfLivePointsTotal(value: object): value is LivePointsTotal {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('total_live_points' in value) || value['total_live_points'] === undefined) return false;
+    return true;
+}
+
+export function LivePointsTotalFromJSON(json: any): LivePointsTotal {
+    return LivePointsTotalFromJSONTyped(json, false);
+}
+
+export function LivePointsTotalFromJSONTyped(json: any, ignoreDiscriminator: boolean): LivePointsTotal {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'total_live_points': json['total_live_points'],
+    };
+}
+
+export function LivePointsTotalToJSON(value?: LivePointsTotal | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'total_live_points': value['total_live_points'],
+    };
+}
+

package/models/ReqGetLivePointsTotal.ts

@@ -0,0 +1,69 @@
+/* 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 ReqGetLivePointsTotal
+ */
+export interface ReqGetLivePointsTotal {
+    /**
+     *  made optional to support header auth clients
+     * @type {string}
+     * @memberof ReqGetLivePointsTotal
+     */
+    auth?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetLivePointsTotal
+     */
+    account_index: number;
+}
+
+/**
+ * Check if a given object implements the ReqGetLivePointsTotal interface.
+ */
+export function instanceOfReqGetLivePointsTotal(value: object): value is ReqGetLivePointsTotal {
+    if (!('account_index' in value) || value['account_index'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetLivePointsTotalFromJSON(json: any): ReqGetLivePointsTotal {
+    return ReqGetLivePointsTotalFromJSONTyped(json, false);
+}
+
+export function ReqGetLivePointsTotalFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetLivePointsTotal {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'] == null ? undefined : json['auth'],
+        'account_index': json['account_index'],
+    };
+}
+
+export function ReqGetLivePointsTotalToJSON(value?: ReqGetLivePointsTotal | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'account_index': value['account_index'],
+    };
+}
+

package/package.json

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