zklighter-perps

TypeScript client for the Lighter Perps REST API, published to npm as zklighter-perps.

The client is generated from the backend's OpenAPI spec with OpenAPI Generator (typescript-fetch). It ships raw .ts ("main": "index.ts"), so your bundler or tsc compiles it along with your own code.

Install

npm install zklighter-perps

Usage

import { Configuration, OrderApi } from 'zklighter-perps'

const orderApi = new OrderApi(
  new Configuration({ basePath: 'https://mainnet.zklighter.elliot.ai' }),
)

const orderBooks = await orderApi.orderBooks()

Every API group has a class in apis/ (AccountApi, OrderApi, TransactionApi, ...) and every request/response type lives in models/. basePath defaults to mainnet; pass the testnet URL to target testnet. Endpoints that need authentication take an auth parameter.

Development

npm install         # also wires the git hooks (.githooks)
npm run typecheck   # tsc --noEmit, the same check CI runs
npm run scan:secrets

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.

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 with the recommended preset; exclusions go in .secretlintignore.