zklighter-perps 1.0.0

package/apis/RootApi.ts

@@ -0,0 +1,56 @@
+/* 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 {
+  Status,
+} from '../models/index';
+import {
+    StatusFromJSON,
+    StatusToJSON,
+} from '../models/index';
+
+/**
+ * 
+ */
+export class RootApi extends runtime.BaseAPI {
+
+    /**
+     * Get status of zklighter
+     */
+    async getStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StatusFromJSON(jsonValue));
+    }
+
+    /**
+     * Get status of zklighter
+     */
+    async getStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status> {
+        const response = await this.getStatusRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/TransactionApi.ts

@@ -0,0 +1,608 @@
+/* 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 {
+  EnrichedTx,
+  NextNonce,
+  SignBody,
+  TxHash,
+  Txs,
+} from '../models/index';
+import {
+    EnrichedTxFromJSON,
+    EnrichedTxToJSON,
+    NextNonceFromJSON,
+    NextNonceToJSON,
+    SignBodyFromJSON,
+    SignBodyToJSON,
+    TxHashFromJSON,
+    TxHashToJSON,
+    TxsFromJSON,
+    TxsToJSON,
+} from '../models/index';
+
+export interface GetAccountPendingTxsRequest {
+    by: GetAccountPendingTxsByEnum;
+    value: string;
+    types?: number;
+}
+
+export interface GetAccountTxsRequest {
+    limit: number;
+    by: GetAccountTxsByEnum;
+    value: string;
+    index?: number;
+    types?: number;
+}
+
+export interface GetBlockTxsRequest {
+    by: GetBlockTxsByEnum;
+    value: string;
+}
+
+export interface GetL2SignatureBodyRequest {
+    txType?: number;
+    txInfo?: string;
+}
+
+export interface GetNextNonceRequest {
+    accountIndex: number;
+    subAccountIndex: number;
+}
+
+export interface GetPendingTxsRequest {
+    limit: number;
+    index?: number;
+}
+
+export interface GetTxRequest {
+    by: GetTxByEnum;
+    value: string;
+}
+
+export interface GetTxFromL1TxHashRequest {
+    hash: string;
+}
+
+export interface GetTxsRequest {
+    limit: number;
+    index?: number;
+}
+
+export interface SendTxRequest {
+    txType?: number;
+    txInfo?: string;
+}
+
+/**
+ * 
+ */
+export class TransactionApi extends runtime.BaseAPI {
+
+    /**
+     * Get pending transactions of a specific account
+     */
+    async getAccountPendingTxsRaw(requestParameters: GetAccountPendingTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Txs>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getAccountPendingTxs().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getAccountPendingTxs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        if (requestParameters['types'] != null) {
+            queryParameters['types'] = requestParameters['types'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountPendingTxs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get pending transactions of a specific account
+     */
+    async getAccountPendingTxs(requestParameters: GetAccountPendingTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Txs> {
+        const response = await this.getAccountPendingTxsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get transactions of a specific account
+     */
+    async getAccountTxsRaw(requestParameters: GetAccountTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Txs>> {
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getAccountTxs().'
+            );
+        }
+
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getAccountTxs().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getAccountTxs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        if (requestParameters['types'] != null) {
+            queryParameters['types'] = requestParameters['types'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountTxs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get transactions of a specific account
+     */
+    async getAccountTxs(requestParameters: GetAccountTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Txs> {
+        const response = await this.getAccountTxsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get transactions in a block
+     */
+    async getBlockTxsRaw(requestParameters: GetBlockTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Txs>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getBlockTxs().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getBlockTxs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/blockTxs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get transactions in a block
+     */
+    async getBlockTxs(requestParameters: GetBlockTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Txs> {
+        const response = await this.getBlockTxsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get transaction signature body
+     */
+    async getL2SignatureBodyRaw(requestParameters: GetL2SignatureBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignBody>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['txType'] != null) {
+            formParams.append('tx_type', requestParameters['txType'] as any);
+        }
+
+        if (requestParameters['txInfo'] != null) {
+            formParams.append('tx_info', requestParameters['txInfo'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/l2Signature`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SignBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Get transaction signature body
+     */
+    async getL2SignatureBody(requestParameters: GetL2SignatureBodyRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignBody> {
+        const response = await this.getL2SignatureBodyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get next nonce for a specific account
+     */
+    async getNextNonceRaw(requestParameters: GetNextNonceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NextNonce>> {
+        if (requestParameters['accountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'accountIndex',
+                'Required parameter "accountIndex" was null or undefined when calling getNextNonce().'
+            );
+        }
+
+        if (requestParameters['subAccountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'subAccountIndex',
+                'Required parameter "subAccountIndex" was null or undefined when calling getNextNonce().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['accountIndex'] != null) {
+            queryParameters['account_index'] = requestParameters['accountIndex'];
+        }
+
+        if (requestParameters['subAccountIndex'] != null) {
+            queryParameters['sub_account_index'] = requestParameters['subAccountIndex'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/nextNonce`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NextNonceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get next nonce for a specific account
+     */
+    async getNextNonce(requestParameters: GetNextNonceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NextNonce> {
+        const response = await this.getNextNonceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get pending transactions
+     */
+    async getPendingTxsRaw(requestParameters: GetPendingTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Txs>> {
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getPendingTxs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/pendingTxs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get pending transactions
+     */
+    async getPendingTxs(requestParameters: GetPendingTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Txs> {
+        const response = await this.getPendingTxsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get transaction by hash or sequence index
+     */
+    async getTxRaw(requestParameters: GetTxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnrichedTx>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getTx().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getTx().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/tx`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EnrichedTxFromJSON(jsonValue));
+    }
+
+    /**
+     * Get transaction by hash or sequence index
+     */
+    async getTx(requestParameters: GetTxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnrichedTx> {
+        const response = await this.getTxRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get L1 transaction by L1 transaction hash
+     */
+    async getTxFromL1TxHashRaw(requestParameters: GetTxFromL1TxHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnrichedTx>> {
+        if (requestParameters['hash'] == null) {
+            throw new runtime.RequiredError(
+                'hash',
+                'Required parameter "hash" was null or undefined when calling getTxFromL1TxHash().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['hash'] != null) {
+            queryParameters['hash'] = requestParameters['hash'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/txFromL1TxHash`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EnrichedTxFromJSON(jsonValue));
+    }
+
+    /**
+     * Get L1 transaction by L1 transaction hash
+     */
+    async getTxFromL1TxHash(requestParameters: GetTxFromL1TxHashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnrichedTx> {
+        const response = await this.getTxFromL1TxHashRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get transactions which are already packed into blocks
+     */
+    async getTxsRaw(requestParameters: GetTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Txs>> {
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getTxs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/txs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get transactions which are already packed into blocks
+     */
+    async getTxs(requestParameters: GetTxsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Txs> {
+        const response = await this.getTxsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Send raw transaction
+     */
+    async sendTxRaw(requestParameters: SendTxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TxHash>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['txType'] != null) {
+            formParams.append('tx_type', requestParameters['txType'] as any);
+        }
+
+        if (requestParameters['txInfo'] != null) {
+            formParams.append('tx_info', requestParameters['txInfo'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/sendTx`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TxHashFromJSON(jsonValue));
+    }
+
+    /**
+     * Send raw transaction
+     */
+    async sendTx(requestParameters: SendTxRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TxHash> {
+        const response = await this.sendTxRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetAccountPendingTxsByEnum = {
+    AccountIndex: 'account_index',
+    L1Address: 'l1_address'
+} as const;
+export type GetAccountPendingTxsByEnum = typeof GetAccountPendingTxsByEnum[keyof typeof GetAccountPendingTxsByEnum];
+/**
+ * @export
+ */
+export const GetAccountTxsByEnum = {
+    AccountIndex: 'account_index',
+    L1Address: 'l1_address'
+} as const;
+export type GetAccountTxsByEnum = typeof GetAccountTxsByEnum[keyof typeof GetAccountTxsByEnum];
+/**
+ * @export
+ */
+export const GetBlockTxsByEnum = {
+    Height: 'block_height',
+    Commitment: 'block_commitment'
+} as const;
+export type GetBlockTxsByEnum = typeof GetBlockTxsByEnum[keyof typeof GetBlockTxsByEnum];
+/**
+ * @export
+ */
+export const GetTxByEnum = {
+    Hash: 'hash',
+    SequenceIndex: 'sequence_index'
+} as const;
+export type GetTxByEnum = typeof GetTxByEnum[keyof typeof GetTxByEnum];